Workflow Triggers

Trigger workflow

Changed on

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

post/v1/notify

Request

  • Base URL: https://api.knock.app
  • URL: https://api.knock.app/v1/notify
  • Auth: HTTP bearer

Request body

cancellation_keystring nullable

A 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 10MB limit on the size of the full data payload. Any individual string value greater than 1024 bytes in length will be truncated in your logs.

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