latestOpenAPI 3.0.32026-08-2142130334.7 KB

0a94056fba48

Webhook sources

Route source events to a conversation

Routes a source's events into a conversation the authenticated member belongs to. Requires an API key bound to a live workspace admin or owner with webhooks:write. Omit events to route everything; pass provider preset event ids to filter. The result can be replayed with the same Idempotency-Key for 24 hours while the route remains unchanged.

post/webhook-sources/{sourceId}/routes

Path parameters

sourceIdstring required

Webhook source identifier.

Headers

Idempotency-Keystring required

Idempotency key.

Required key for safe retries. Reusing it with different parameters returns 409 idempotency_conflict. The original result can be replayed for 24 hours while the created source or route remains unchanged.

Request body

conversation_idstring required

Target conversation identifier.

eventsstring[]

Provider preset event ids to route. Omit to route every event.

Example request

{
  "conversation_id": "01jzn7e61x3a7v9h2r7t2m3q4p"
}

Response

Created event route.

Example response

{
  "data": {
    "conversation_id": "01jzn7e61x3a7v9h2r7t2m3q4p",
    "route_id": "01jzn7e61x3a7v9h2r7t2m3q4p"
  }
}