Skip to content

Webhook ​

Where Calloop sends your events and lookup requests, which events you receive, and the secret that signs them (events.md).

MethodPathBodyResponse
GET/v1/webhook—{ webhook: { url, lookupUrl, eventTypes, secretSet } }
PUT/v1/webhook{ url?, lookup_url?, event_types? }{ webhook }, plus secret the first time one is created
POST/v1/webhook/secret—{ secret } — a new one, the only time it is shown
  • url receives the events; lookup_url is the optional lookup hook. Both must be https:// URLs of at most 500 characters (400 otherwise, details.fieldurl or lookup_url). As with every PUT, a URL you omit is removed: without url, events are kept and delivered once you set one.
  • event_types — the event types you want, e.g. ["call.created", "call.ended"]; omitted = every type (an empty list is a 400). Events of other types are not sent and don't appear in GET /v1/events. An unknown type is a 400 that lists the known ones. A change reaches every worker within a minute.
  • The first PUT that sets a URL creates the secret and returns it once. POST /v1/webhook/secret replaces it at once: the next request is signed with the new one, so update your side right after.

Calloop — the call engine behind your product.