Webhooks

A webhook sends a signed message to a URL of yours whenever something happens in your workspace, such as a session finishing or a study report being ready. Use it to post to Slack through Zapier, update a ticket, or start your own pipeline. Only admins can manage webhooks.

Add an endpoint

1. Go to Settings → API & MCP and, under Webhooks, click Add endpoint.
2. Enter the Endpoint URL. It must start with https:// and be reachable from the internet.
3. Tick the Events you want. readout.ready is ticked to start with.
4. Click Add endpoint.
5. Copy the signing secret (it starts with whsec_). Your server uses it to check each message came from us.

Test and monitor

• Send test event sends a sample message to the endpoint.
• Recent deliveries lists what was sent and whether your server accepted it. You can retry a failed delivery.
• Pause an endpoint to stop deliveries for a while, and resume it later.
• Delete endpoint removes it.

Rotate the secret

Click Rotate signing secret to get a new one. For 24 hours, messages are signed with both the old and the new secret, so you can switch over without missing anything.

Events and payloads

The list of events, the message format, how to check the signature and how retries work are in the developer guide: Webhooks for developers.