Before you start
- Your endpoint’s signing secret, which starts with
whsec_. In Casefile, open the organization menu, then Settings, then Webhooks, choose the endpoint, and choose Show beside Signing secret. - A receiver that can read a request’s body exactly as it arrived.
Steps
1
Keep the body as it arrived
Read the body as text before you parse it as JSON.
The signature covers the exact text, so a body parsed and written out again no longer matches it.
2
Read the three headers
Each request carries
webhook-id, webhook-timestamp and webhook-signature.3
Check the signature
Pass the secret, the headers and the body to this function.
It returns the event’s ID when the request came from Casefile, and undefined when it did not or when it was sent too long ago.For 24 hours after a secret is rotated, each request carries one signature made with the old secret and one made with the new.The function accepts a request when any of its signatures matches your secret.
verify-webhook.mjs
4
Skip events you have handled
Casefile may send the same event more than once, each time with the same
webhook-id.
Keep the IDs you have handled, and skip a request whose ID you have seen.5
Answer quickly
Answer within 15 seconds with a status from
200 to 299.
Any other answer, or none in time, counts as a failure, and Casefile sends the same event again up to 7 times over about 28 hours.Do slow work after you answer.The function returns the event’s ID for a request from Casefile, and undefined
for the same request with one character of its body changed.