Skip to main content
POST
Test a workflow

Authorizations

Authorization
string
header
required

An API key from the dashboard. The scopes listed on each operation are the resource:action grants a key needs (messages:send, subscribers:read, topics:*, *); account:* scopes and key management are session-only. Workspace keys (bk_ws_) are what a backend uses: they resolve to the default tenant on their own, so an integration that does not use tenants sends no extra header, and add buzzkit-tenant only to address a different tenant. Tenant keys (bk_tn_) are locked to one tenant and need no header either; client keys (bk_pk_) ship inside an app and only work on /v1/client/*.

Path Parameters

workflowSlug
string
required
Required string length: 3 - 48
Pattern: ^[a-z0-9]+(?:-[a-z0-9]+)*$

Body

version
integer
Required range: x >= 1
externalId
string
Required string length: 1 - 256
attributes
object
event
object
at
string
assume
object

Response

Response for status 200

success
boolean
required
data
object | null
required
error
object | null
required
metadata
object
required