Check which secret a sender signs with
Do this when an event automation gets nothing, or its sender reports its deliveries as refused, and you suspect the sender holds the wrong secret. Jaah shows an automation's signing secret only once, so you can't read it back to compare. Check signature lets you test the secret you think the sender has against one of its real requests, without rotating anything.
It works for automations that sign each request with a secret: GitHub, GitLab and Bitbucket, and a webhook that still uses an older signed secret. A webhook that uses an API key, and a Sentry, Datadog, PagerDuty or CloudWatch monitor, has no Check signature.
Who can do this: Org Owners and Org Admins. Only they see automations.
- Collect one request from the sender's own delivery log: its raw body exactly as sent, and the value of
its signature header, such as
X-Jaah-Signature-256. Have the secret the sender is set up with to hand. - In the sidebar, select Audit, then the Automations tab, and open the automation.
- Under Endpoint, select Check signature. It sits beside Rotate secret, or beside Reveal secret (one time) if the secret was never shown.
- In Check a signature, paste the sender's secret into Secret, the request's body into Body, and its signature header into Signature. The check runs in your browser: nothing is sent or saved.
- Select Check. Match. means the sender signs with that secret, so look elsewhere for the fault. No match. means the secret, the body or the signature differs from what was sent.
- Before you trust No match., make sure you pasted the whole body, byte for byte. A body sent with CRLF line endings never matches here, because the box turns them into LF. Change any field and select Check again; each edit clears the last answer.
- Select Close when you are done. Closing drops everything you typed.
If the secret is wrong, or nobody has it any more, select Rotate secret under Endpoint, then Rotate secret again to confirm. The old secret stops working at once. Store this secret now shows the new one a single time: copy it, select I’ve stored it, and update every sender with it.
Related
- Create an automation: set up an event automation and connect its sender.
- Run, pause or change an automation: read its runs once events arrive again.
- An integration isn't receiving events: other reasons a sender's events never arrive.