Skip to main content
POST

Authorizations

Authorization
string
header
required

Body

application/json
callbackUrl
string<uri>
required

The URL that Zeeg will send webhook payloads to. Must be a valid HTTPS URL.

events
enum<string>[]
required

List of event types to subscribe to.

Available options:
invitee.scheduled,
invitee.cancelled,
routing_form.submitted,
ai_agent.call_completed
scope
enum<string>
required

The scope of the webhook subscription. Use user for personal webhooks or organization for organization-wide webhooks.

Available options:
user,
organization
token
string

Optional verification token. When set, Zeeg includes it in a Token header on every webhook delivery (including the test endpoint). Use it to verify that incoming requests originate from Zeeg.

Must be at least 8 characters and contain only printable, non-whitespace ASCII characters. Leading and trailing whitespace are trimmed automatically.

Required string length: 8 - 1000
Pattern: ^[\x21-\x7E]+$

Response

Created

success
boolean
resource
object

The created webhook.

testResult
object | null

Result of the synthetic test event sent to the callbackUrl. null only when the test was skipped (rare).

Last modified on April 29, 2026