SnozeDevelopers
API referenceActions

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.

POST
/v1/workspaces/{workspaceId}/databases/{databaseId}/records/{recordId}/button-fields/{fieldId}/run

Authorization

apiKey
headerAuthorizationBearer <snoze_sk_…>

Workspace API key created in Workspace settings → API keys. Scopes on the key bound what it can read and write.

Path Parameters

workspaceId*string
databaseId*string
recordId*string
fieldId*string

Response Body

Success

application/json
  1. response
data*
Example Request
curl -X POST 'https://api.snoze.dev/v1/workspaces/string/databases/string/records/string/button-fields/string/run'
Example Response
{  "data": {    "id": "string",    "actionId": "string",    "workspaceId": "string",    "status": "started",    "startedAt": "string",    "completedAt": "string",    "error": "string",    "result": {},    "input": {},    "stepResults": {      "property1": {        "stepId": "string",        "index": 0,        "kind": "string",        "status": "pending",        "result": {},        "error": "string",        "startedAt": "string",        "completedAt": "string"      },      "property2": {        "stepId": "string",        "index": 0,        "kind": "string",        "status": "pending",        "result": {},        "error": "string",        "startedAt": "string",        "completedAt": "string"      }    }  }}

List an action's recent runs

Returns the action's runs, newest first. Requires the `actions:read` permission plus view access to the action. Pass `limit` to change the page size; it defaults to 30 and is capped at 100.

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.