Capture a matching trigger event
Reads up to 100 new events from the caller’s ACL-projected workspace stream and returns the first event matching the draft trigger, including its scopes, refinements, and filters. Omit afterVersion to establish the current cursor; pass the returned cursor when polling. Requires automations:write and edit access to the automation, plus workspace:read for the event stream. Does not publish or execute the automation.
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
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
curl -X POST "https://example.com/v1/workspaces/string/automations/string/trigger-samples/events" \ -H "Content-Type: application/json" \ -d '{ "trigger": { "kind": "manual" } }'{ "data": { "afterVersion": 0, "sample": { "id": "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}Run the action behind a database button field
Resolves the action configured on a record's button field, maps the field's bindings from that record, and runs it with the record context attached to the input. Requires the `actions:run` permission plus edit access to the bound action; a field that is not a button, an unreadable button configuration, or a disabled action is rejected with a validation error. Send an `Idempotency-Key` header to make retries safe; a replay within the window returns the original response.
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.