Docs
API reference

response.completed

A background: true response completed with an answer. The event names the response and carries no answer: fetch it with getResponse.

Header Parameters

webhook-id*string

The event's id. Deduplicate on it.

webhook-timestamp*string

Unix seconds at which this attempt was signed.

webhook-signature*string

v1, and the base64 HMAC-SHA256 of the message, by Standard Webhooks, with the endpoint's whsec_ secret.

Request Body

application/json
  1. body

What a webhook endpoint receives when a background: true response ends. The event names the response and carries no answer: fetch it with GET /v1/responses/{id}.

created_at*integer

Unix seconds.

data*
id*string

Also the webhook-id header.

Match^evt_[0-9a-f]{32}$
object*string
type*string
Value in"response.completed""response.failed""response.cancelled"

Response Body

Any 2xx within 15 seconds acknowledges the event. Anything else, a redirect included, is a failed attempt and is retried; redirects are not followed.

Example Requests
POST/response.completed

What a webhook endpoint receives when a background: true response ends. The event names the response and carries no answer: fetch it with GET /v1/responses/{id}.

Request Body
application/json
{  "created_at": 0,  "data": {    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"  },  "id": "string",  "object": "event",  "type": "response.completed"}
Header Parameters
{  "webhook-id": "string",  "webhook-timestamp": "string",  "webhook-signature": "string"}

response.cancelled Webhook

A `background: true` response was cancelled. The event names the response and carries no answer: fetch it with `getResponse`.

response.failed Webhook

A `background: true` response failed or was declined. The event names the response and carries no answer: fetch it with `getResponse`.