Trigger an event for a user

POST 
/run/event

This endpoint runs a workflow that uses a **Custom Event **. Note that this endpoint cannot be used to invoke a workflow that has a Custom Webhook Trigger.

If you have defined a custom JSON body for the Custom Event, it should be passed into the data body parameter.

Request

Header Parameters

Authorization stringrequired

Default value: bearer YOUR_API_KEY

application/json

Body

event stringrequired

The name of the custom event to run.

userId stringrequired

The user Id the workflow belongs to

data jsonrequired

The key-value pairs you want to send as defined in the custom event. This data will be used in expressions during the workflow execution.

Responses

200

200

application/json

Schema

Schema

message string

Example (from schema)

{
  "message": "Event successfully triggered"
}

Result

{
    "message": "Event successfully triggered"
}

Loading...