Fire a custom trigger with payload
Invoke a custom trigger directly with an arbitrary JSON payload.
Fan-out: a trigger may be referenced by multiple flows (workflows). Firing it enqueues one execution per enabled, non-deleted flow attached to this trigger, each receiving the same payload. The enqueuedCount in the response reports how many were enqueued (0 if no flows are attached, or if all matching flows are gated by a cooldown).
Payload validation:
- If the trigger has a
customPayloadSchema, the payload is validated against it (JSON Schema via AJV). - If no schema is configured, the payload only needs to be a JSON object — any keys and values are accepted.
Only triggers with activation = "custom" can be fired through this endpoint; event and schedule triggers return 409.
Authorizations
Bearer token via Authorization header
Path Parameters
Body
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
Unique ID for this fire invocation. Job IDs in the execution queue are derived from it (one per enqueued flow).
Number of flow executions enqueued. May be 0 if no flows are attached to this trigger, or if all attached flows are currently in cooldown.
x >= 0