Events
Results and goal notices name the event in
event, voice and watch events in type. Goal notices carry goal_id, status, message and hold fields.
Delivery
- A
2xxanswer delivers. Anything else fails the attempt, including a redirect, which is never followed. The response body is ignored. An attempt times out after 5 seconds. - The URL must use
https, have at most 2,048 characters and no credentials, and its host and every address it resolves to must be public. It is checked when set and on every attempt. case.result: up to 6 attempts, 2, 4, 8, 16 and 32 minutes apart.GET /v1/compute/{goalId}/cases/{key}lists each indeliverieswithstatus,attempts,last_errorandnext_attempt_at. A case that asked for approval sends only the result its approver released.- Goal notices: up to 6 attempts on the same schedule. A hold notice stops when the hold ends.
goal.budget_warningis sent when spend crossesalert_threshold. watch.change: up to 6 attempts over about 15 hours.GET /v1/org/watches/{id}/deliveriesshowswebhook_status,webhook_attemptsandwebhook_last_error.voice.inbound.completed: one attempt. The call stays inGET /v1/tools/voice/inbound.- Events can arrive out of order or twice. Drop repeats by the dedupe key.
Verify a signature
X-OneShot-Signature: t=<unix seconds>,v1=<hex HMAC-SHA256 of "<t>.<raw body>">. Each attempt is signed again with a new t.
Private-storage organizations
When an organization’s controls require private storage, or cannot be read, each attempt sends a minimal body: IDs, status, timestamps and anapi_path. Content, the event label and the attempt count are left out.
Read
api_path with your normal API credentials. The webhook secret does not authorize reads.