Webhooks

Simple AI uses webhooks to notify your application in real-time about events that happen during calls.

​

Available Events

We currently support the following webhook events:

​

Call Transcript Update

The call.transcript_update event is sent whenever there’s an update to the call transcript during the conversation. This allows you to follow the conversation in real-time and update your application accordingly.

Learn more about Call Transcript Update webhooks

​

Call Completed

The call.completed event is sent when a call has finished. This is useful for triggering post-call processing or updating your application’s state.

Learn more about Call Completed webhooks

​

Webhook Format

All webhook events follow a consistent format:

{
  "event_type": "event.name",
  "payload": {
    "call_id": "uuid",
  }
}

​

Retry Policy

If your endpoint is unavailable or returns an error status code, we’ll retry the webhook delivery with an exponential backoff. The attempt field in the payload indicates which attempt number this delivery represents.

​

Security

Webhooks are sent with a signature header that allows you to verify that the request came from Simple AI. We recommend validating this signature before processing webhook data.

​

Best Practices

1. Acknowledge quickly: Return a 2xx status code as soon as you receive the webhook. Process the webhook data asynchronously if needed.
2. Handle duplicates: Due to our retry policy, you may occasionally receive the same webhook multiple times. Design your webhook handler to be idempotent.
3. Verify signatures: Always verify the webhook signature to ensure the request came from Simple AI.
4. Monitor failures: Keep track of webhook delivery failures to ensure you’re not missing important events.