A webhook endpoint is a URL in your application where Tiro sends an HTTP POST request the moment a note, summary, or document changes. You register the endpoint once in Tiro Platform, and Tiro pushes every event to it in real time — so you never poll the API for updates.
Webhooks allow your application to receive real-time notifications when events occur in your workspace. Instead of polling the API, Tiro sends HTTP POST requests to your endpoint whenever something happens.
Events represent actions that occur in your workspace. See Note Events, Note Document Events, Note Summary Events, and FolderNote Events for detailed information.
Webhook events are designed to stay under several hundred KB by including only metadata. Large content like transcripts and scripts are accessed via separate APIs to ensure webhook reliability and performance.
Webhook requests are authenticated using your secret key in the Authorization header:
Authorization: Bearer {secret_key}
The secret key is provided when you configure your webhook endpoint and is used to verify the authenticity of incoming requests. Simply compare the provided secret with your configured secret to verify authenticity.
Webhook endpoints are registered and managed per workspace. Add an endpoint in Platform and it receives events from the current workspace. If you operate several workspaces, register an endpoint for each one and use the top-level workspaceGuid in the payload to tell which workspace an event came from.
With your endpoint registered, get familiar with the Event Structure you’ll receive — then read Best Practices to handle retries, idempotency, and signature verification before you go live.