Skip to main content
POST
JavaScript

Authorizations

Authorization
string
header
required

Bearer token via Authorization header

Headers

idempotency-key
string

Idempotency-Key: 1-255 printable ASCII characters. Same key with a different request body is a 422 idempotency_key_reused. A retryable in-flight duplicate is a 409 with Retry-After and x-should-retry: true; a terminal duplicate is a 409 with x-should-retry: false. A replay returns the current resource state with Idempotent-Replayed: true.

Required string length: 1 - 255
Pattern: ^[\x21-\x7E]{1,255}$
Example:

"b3f6a9f0-6f1a-4e9a-9e7a-9c9b6b6a5a3f"

Path Parameters

triggerId
string<uuid>
required

Body

application/json
payload
object
required

Arbitrary JSON object forwarded to every flow attached to this trigger. Validated against the trigger's customPayloadSchema when one is configured; otherwise only "must be a JSON object" is enforced.

Response

Custom trigger fired; one execution enqueued per enabled flow attached to this trigger

deduplicated
boolean
required

True when at least one attached flow was skipped because it already had an execution for this (flow, invocationId). Only ever true when the request carried an Idempotency-Key.

enqueuedCount
integer
required

Number of flow executions enqueued. May be 0 if no flows are attached to this trigger, if all attached flows are currently in cooldown, or if every attached flow was deduplicated.

Required range: x >= 0
invocationId
string<uuid>
required

Unique ID for this fire invocation (derived from the Idempotency-Key header when one is sent, otherwise generated).