Appearance
Webhook
Where Calloop sends your events and lookup requests, which events you receive, and the secret that signs them (events.md).
| Method | Path | Body | Response |
|---|---|---|---|
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 |
urlreceives the events;lookup_urlis the optional lookup hook. Both must behttps://URLs of at most 500 characters (400otherwise,details.fieldurlorlookup_url). As with everyPUT, a URL you omit is removed: withouturl, 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 a400). Events of other types are not sent and don't appear inGET /v1/events. An unknown type is a400that lists the known ones. A change reaches every worker within a minute.- The first
PUTthat sets a URL creates the secret and returns it once.POST /v1/webhook/secretreplaces it at once: the next request is signed with the new one, so update your side right after.