---
title: "Trigger workflow"
method: POST
path: "/v1/notify"
tags: ["Workflow Triggers"]
---

# Trigger workflow

`POST /v1/notify`

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

## Request body

- NotifyRequest — A request to trigger a notification workflow.
  - `actor` union, required — A reference to a recipient, either a user identifier (string) or an object reference (ID, collection).
    - string — The ID of the user which is used as the reference for the recipient.
    - object — A reference to a recipient object.
      - `collection` string — The collection the recipient object belongs to.
      - `id` string — An identifier for the recipient object.
  - `cancellation_key` string, nullable — An optional key that is used to reference a specific workflow trigger request when issuing a [workflow cancellation](/send-notifications/canceling-workflows) request. Must be provided while triggering a workflow in order to enable subsequent cancellation. Should be unique across trigger requests to avoid unintentional cancellations.
  - `data` object, 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](/developer-tools/api-logs#log-truncation) in your logs.
  - `name` string, required — The key of the workflow to trigger.
  - `recipients` RecipientReference[], required — A list of recipients.
    - union — A reference to a recipient, either a user identifier (string) or an object reference (ID, collection).
      - string — The ID of the user which is used as the reference for the recipient.
      - object — A reference to a recipient object.
        - `collection` string — The collection the recipient object belongs to.
        - `id` string — An identifier for the recipient object.

## Response `200`

OK

- NotifyResponse — The response from triggering a workflow.
  - `result_id` string, required — This value allows you to track individual messages associated with this trigger request.

---

[API](https://skmtc.net/knocklabs/apis/knock-api.md) · [All operations](https://skmtc.net/knocklabs/apis/knock-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/knocklabs/knock-api/revisions/4b8499dddbc5/schema)