This article provides instructions for customers using Rally V1. Your Rally admin will let you know when it's time to switch to Rally for Teams. For customers using Rally for Teams, jump to the Rally for Teams section below.
Developers can use the Rally API and webhooks to access and update specific data from your workspace. Review our Rally UXR Developer Docs for complete instructions on each endpoint.
Access the Rally API
🚨 Managing webhooks requires a Developer role type. Generating an API Key requires a Developer or Admin role type.
If you haven't already, invite a Developer to your Rally workspace. The process below must be completed by a Developer in Rally.
Manage Your API Key
In the top right corner of Rally, select your user icon and select 'Settings'.
From the bottom of the sidebar, select 'API'.
Select 'Generate API Key'.
In the popup, select 'Create New API Key'.
Click to copy the API Key before closing the popup. Once you close the popup, you will not be able to view your API key.
Your API key gives you access to the Rally API. Your API key is sensitive as it allows access to your workspace data exposed by Rally API. Keep it safe and avoid sharing it anywhere public. In the event that your API key is compromised, you can rotate it to generate a new key and deactivate the old one.
Select 'Done' to close the popup after copying the API Key.
Rotate API Key
If you need to access your API Key again after generating the first one and closing the popup, you will need to select 'Rotate API Key' to generate a new API Key, which will invalidate the previous one.
Manage Webhooks
We use Svix to provide a secure, reliable, and scalable webhook platform that gives you access to specific Rally events from your workspace. View Event Catalog.
Visit the Svix application portal for your workspace to manage your webhooks.
Rally for Teams
The steps above are for customers using Rally V1. The section below includes specific instructions for customers using Rally for Teams.
Developers can use the Rally API and webhooks to access and update specific data from your workspace. Review our Rally UXR Developer Docs for complete instructions on each endpoint.
Access the Rally API
🚨 Managing webhooks requires a Developer role type. Generating an API Key requires a Developer or Admin role type.
If you haven't already, invite a Developer to your Rally workspace. The process below must be completed by a Developer in Rally.
Manage Your API Key
In the top left corner of Rally, select your workspace name and select Settings.
From the sidebar, select API.
Select Generate API Key.
In the popup, select Create new API key.
Click to copy the API Key before closing the popup. Once you close the popup, you will not be able to view your API key.
Your API key gives you access to the Rally API. Your API key is sensitive as it allows access to your workspace data exposed by Rally API. Keep it safe and avoid sharing it anywhere public. In the event that your API key is compromised, you can rotate it to generate a new key and deactivate the old one.
Select Done to close the popup after copying the API Key.
Rotate API Key
If you need to access your API Key again after generating the first one and closing the popup, you will need to select Rotate API Key to generate a new API Key, which will invalidate the previous one.
Manage Webhooks
We use Svix to provide a secure, reliable, and scalable webhook platform that gives you access to specific Rally events from your workspace. View Event Catalog.
Visit the Svix application portal for your workspace to manage your webhooks.