Passer au contenu principal
POST
Create a signed webhook subscription
Abonnements webhook signés

Autorisations

Authorization
string
header
requis

API key (fam_..., created under Settings → API Keys) or an OAuth 2.0 access token (fam_at_...). REST operations also require API Access for the credential's workspace. Keys can be restricted to scopes such as assistants:read, calls:write, campaigns:write, automations:read, dashboards:read, dashboards:write, leads:write, segments:write, loop:read, loop:write, phone_numbers:write, sip_trunks:write, knowledge:write, voices:read, billing:read, billing:write, settings:write, platform:read, platform:write; a *:write scope implies the matching *:read. Automation and dashboard endpoints also accept the legacy calls:* scope. Keys without scope restrictions have full access within the workspace's available capabilities.

Corps

application/json
url
string<uri>
requis

Public HTTPS callback URL without embedded credentials, fragment or custom port. Private destinations and redirects are blocked at delivery.

Maximum string length: 2048
events
enum<string>[]
requis

Events to deliver. Requires calls:read for call/conversation events and bookings:read for booking events.

Required array length: 1 - 5 elements
Options disponibles:
call.completed,
conversation.ended,
booking.created,
booking.cancelled,
booking.rescheduled
secret
string
requis
write-only

Signing secret stored by the receiver. Sent as HMAC-SHA256 over the exact request bytes in X-Famulor-Signature. Never returned by this API.

Required string length: 16 - 256
id
string<uuid>

Optional stable UUID. Retrying the same ID with identical settings returns the original subscription; conflicting settings return 409.

Réponse

Successful response.

data
object
requis