Replace an automation's secret
An event automation that receives requests, such as a webhook or GitHub automation, trusts a request only when it is signed with, or carries, the automation's secret. If that secret leaks or nobody has it any more, replace it here.
Who can do this: requires the org admin role. Automations are listed under Audit, which only Org Owners and Admins see.
Not every automation has one. A webhook that takes an API key holds no secret. A Sentry or PagerDuty automation signs with the vendor's own secret: paste the new one into Sentry Client Secret or PagerDuty signing secret under Endpoint and select Save instead.
Replace it
- In the sidebar, select Audit, then the Automations tab.
- Select the automation's name. Its page opens beside the list, on the Setup tab.
- Find Endpoint at the top of the tab. If it shows Reveal secret (one time), the secret has never been shown: select it to see the current secret once, and go to step 5.
- Select Rotate secret. A dialog with the automation's name says the old secret stops working at once. Select Rotate secret again to confirm, or Cancel to keep the old one.
- Store this secret now shows the new secret. Select Copy secret and keep it somewhere safe: this is the only time it is shown.
- Select I’ve stored it to close the dialog.
- Paste the new secret into every sender that posts to this automation, such as the Secret field of a GitHub webhook. If you rotated, the old secret has stopped working.
- To check a sender that signs its requests, select Check signature beside Rotate secret, paste the secret, a request body and its signature header, and select Check.
The next request a sender makes with the new secret shows as a run on the automation's Runs tab.
Related
- Check which secret a sender signs with: find out whether a sender uses the secret you hold before you rotate.
- Start tasks from GitHub: where the secret goes in a GitHub webhook.
- Respond to a leaked secret: what to replace when other secrets leaked too.
- How automations work: event sources, runs and their outcomes.