API Reference

Fire a flow trigger

post
https://api.heymantle.com/v1/flow/extensions/triggers//fire

Fire a custom API trigger to initiate flow runs. Uses standard Bearer token authentication.

Versioning

Use X-Trigger-Version header to specify which version to fire. When supporting multiple versions, make separate fire calls for each version:

POST /triggers/{handle}/fire
X-Trigger-Version: 1
{ ...v1Payload }

POST /triggers/{handle}/fire
X-Trigger-Version: 2
{ ...v2Payload }

Response codes help optimize which versions to send:

  • 200: Event recorded but no active flows use this version
  • 202: Flows were triggered for this version
  • 410: Version is obsolete (stop sending entirely)
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

The handle of the trigger to fire (falls back to ID for backward compatibility)

Body Params

Trigger payload (must match the version's triggerSchema if defined)

Headers
string

Version number to fire (e.g., "1", "2"). If not specified, uses the current version. When supporting multiple versions, make separate calls for each version.

string

The ID of the resource to associate with this trigger fire. Required when the trigger's resourceType is not "organization". The resource must exist and belong to the authenticated organization.

Responses

400

Payload validation failed against triggerSchema

404

Trigger or version not found

Updated about 2 months ago

Language
Credentials
OAuth2
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 2 months ago