Notify

Notify Workflow Run Event

Notify an event to a specific workflow run's waiters.

This endpoint sends an event notification to waiters within a specific workflow run. Unlike the general notify endpoint, this uses a "safe notify" mechanism that guarantees delivery even if no waiter is currently active.

Safe Notify Behavior:

  • If a waiter is currently active, it receives the notification immediately
  • If no waiter is active, the notification is saved in the database
  • When a waiter becomes active later, it will consume the saved notification
  • This ensures events are never lost due to timing issues
post/v2/notify/{workflowRunId}/{eventId}

Request

Path parameters

workflowRunIdstring required

The workflow run ID to notify.

eventIdstring required

The event ID that waiters are listening for.

Request body

object required

Response

Event notification sent or saved successfully

messageIdstring

The ID of the notification message that was published.

deduplicatedboolean

Whether this notification was deduplicated.

errorstring

Error message if the notification failed.

workflowRunIdstring

The workflow run ID if the notification was sent within a workflow.

workflowCreatedAtinteger

The timestamp when the workflow run was created (Unix timestamp in milliseconds).

Changes

No recorded changes to this operation across all 12 revisions of this API.