Skip to main content
POST
Trigger a workflow

Authorizations

Authorization
string
header
required

A session token from subscriber login, used by subscriber.dev's own apps. Requests about an environment also need its ID in the x-environment-id header. From your own code, use an API key.

Body

application/json
key
string
required

The workflow key, e.g. "user-signup".

Minimum string length: 1
subscriber
object
required
payload
object

Data for the templates, available as top-level variables: {"plan": "pro"} is {{ plan }}.

Response

triggered
boolean
required
runPublicId
string
reason
string