Sign in
Workflow Triggers

Trigger workflow

Triggers a workflow with the given key, actor, recipients, and optional data.

post/v1/notify

Request body

cancellation_keystring nullable

An optional key that is used to reference a specific workflow trigger request when issuing a workflow cancellation request. Must be provided while triggering a workflow in order to enable subsequent cancellation. Should be unique across trigger requests to avoid unintentional cancellations.

dataobject nullable

An optional map of data to pass into the workflow execution. There is a 1024 byte limit on the size of any single string value (with the exception of email attachments), and a 10MB limit on the size of the full data payload.

namestring required

The key of the workflow to trigger.

Example request

{
  "actor": "user_123",
  "cancellation_key": "comment_123",
  "data": {
    "comment": "Great work on this feature!",
    "url": "https://example.com/projects/123/comments/456"
  },
  "name": "new-comment",
  "recipients": [
    "user_456",
    {
      "collection": "projects",
      "id": "project_789"
    }
  ]
}

Response

OK

result_idstring required

This value allows you to track individual messages associated with this trigger request.

Example response

{
  "result_id": "wf_1234567890abcdef"
}

Changes