Skip to main content
Subscribe to one or more of these event types when registering an endpoint. Pass an empty events array to subscribe to all.

Common envelope

Every delivery shares the same outer shape:
And these headers:

Events

campaign.started

Fires when a campaign transitions from draft to active.

campaign.paused

Fires when a campaign is paused.

campaign.completed

Fires when every contact’s conversation reaches completed. Synthesis usually starts immediately after.

interview.completed

Fires when a single conversation finishes. Transcript is available via the export endpoints.

synthesis.completed

Fires when the synthesis pipeline finishes for a campaign. The cartography, roadmap, and personas are all queryable now.
This is usually the most useful event — most consumers register only for synthesis.completed and pull the report via GET /v1/interviews/{id}/export/report.

webhook.ping

The synthetic test event, sent when you trigger a test delivery (ontora webhooks test or POST /v1/webhook-endpoints/{id}/test). Use it to verify your receiver and signature handling.
interview.scheduled is accepted as a subscription filter for backwards compatibility but is not currently emitted.