Read a captured webhook sample
Returns the caller’s active capture and its payload once received; the signing secret is never returned here. Requires automations:write and edit access to the automation, and the capture must belong to the caller in this workspace. Expired, canceled, or unavailable captures are rejected. Reading a sample never executes automation actions.
Authorization
apiKey Workspace API key created in Workspace settings → API keys. Scopes on the key bound what it can read and write.
In: header
Path Parameters
Response Body
application/json
application/json
application/json
curl -X GET "https://example.com/v1/workspaces/string/automations/string/trigger-samples/webhook/string"{ "data": { "id": "string", "expiresAt": "string", "capturedAt": "string", "payload": {} }}{ "_tag": "ApiNotFound", "error": "not_found", "message": "That item does not exist, or this key cannot see it.", "status": 404}{ "_tag": "ApiNotFound", "error": "not_found", "message": "That item does not exist, or this key cannot see it.", "status": 404}Start a draft webhook capture
Creates a private, one-shot sample receiver that expires after two minutes, replacing this caller’s previous capture for the automation. Requires automations:write and edit access to the automation. Returns a secret once; send it in the x-snoze-capture-secret header to POST /v1/automation-test-hooks/{id} with a JSON object of at most 1 MB. Capturing does not publish the automation or create runs, jobs, or deliveries.
Cancel a draft webhook capture
Deletes the caller’s capture and any captured payload, immediately preventing further requests to its temporary receiver. Requires automations:write and edit access to the automation; captures belonging to another caller or workspace cannot be canceled. Repeated cancellation is safe and does not change the automation or its runs.