A webhook sends a short JSON message to an address you choose whenever something happens in any project in your workspace. Use it to start an automation in Zapier, Make or your own system.
Add a webhook
- Open Settings, then Connected Apps, then Webhooks. Admins and Members can add one; Viewers and client logins cannot. A Member limited to some projects cannot, since a webhook sends every project's events.
- Paste your Webhook URL. It must start with https://.
- Under Send an event when, untick any event you do not want. All four start ticked.
- Choose Add webhook.
- Copy the Signing secret. Copy it now. It is not shown again.
You can add up to 5 webhooks for the whole workspace.
Events
| Event | Sent when |
|---|---|
| A run finished | A full run of a project's prompts has finished |
| Visibility moved | Visibility changed by half a point or more since the run before |
| A wrong claim was flagged | A run found new wrong or outdated claims about your brand |
| A fix was marked done | A fix in Actions moved to Done |
Every event names its project, so one webhook covers every project.
Test, pause and remove
Each webhook shows its host only, since the rest of the address is kept private, with its events.
- Send test event sends one test message at once, and says whether it worked.
- The switch beside it pauses deliveries without removing the webhook.
- Remove deletes it.
Recent deliveries lists the last 20, each marked Succeeded or Failed, with the HTTP status, the tries and the reason.
Check that a delivery came from us
Every event is signed with your signing secret, so you can check it came from us. The X-KlientBrain-Signature header holds t= (a time in Unix seconds) and v1= (an HMAC-SHA256 of the time, a full stop and the raw request body, keyed with your secret, in hex). Work it out again and compare, and refuse a time more than a few minutes old.
Each delivery has an id that stays the same if it is sent again, so you can ignore repeats. A delivery is tried three times: at once, after 2 seconds and after 10 seconds. Any answer other than a 2xx counts as a failure, and redirects are not followed.
For a step-by-step Zapier set-up, see Zapier.