Skip to navigation
API ReferenceWebhooks

Phone-system outcome action webhook

Signed, at-least-once payload sent to the configured HTTPS receiver. Deliveries keep one stable delivery ID across retries and make no ordering guarantee.

Headers

X-Sailor-Delivery-IdstringRequiredformat: "uuid"
Stable UUID for this logical delivery and every retry.
Idempotency-KeystringRequiredformat: "uuid"

Same stable value as X-Sailor-Delivery-Id.

X-Sailor-Signature-VersionintegerRequired>=1
Integer version of the workspace webhook signing secret.
X-Sailor-SignaturestringRequiredformat: "^t=[0-9]+,v1=[a-f0-9]{64}$"

t=<unix-seconds>,v1=<HMAC-SHA256 hex> over timestamp.delivery-id.exact-raw-body.

Payload

The payload of this webhook request is an object.
error_messagestringRequired
timestampintegerRequired-9007199254740991-9007199254740991
scopeobjectRequired
outcomeobjectRequired
callobjectRequired
destinationobjectOptional

Response

2XX
Return any 2xx status to acknowledge receipt.