Sign in
latestOpenAPI 3.0.32026-08-2142130334.7 KB

0a94056fba48

Webhook sources

Create a webhook source

Creates an inbound webhook source for a supported provider preset. Requires an API key bound to a live workspace admin or owner with webhooks:write. The ingress URL and signing secret response can be replayed with the same Idempotency-Key for 24 hours; after that the secret is not retrievable. Configure the URL and secret in the external service, then attach a route to deliver its events into a conversation.

post/webhook-sources

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

display_namestring nullable

Optional label for the author identity events post as. The source itself keeps the provider's canonical name.

providerstring required

Inbound provider preset key.

signing_secretstring nullable

Signing secret the provider will use. Generated when omitted.

Response

Created inbound webhook source.

Example response

{
  "data": {
    "source_id": "01jzn7e61x3a7v9h2r7t2m3q4p"
  }
}