Skip to main content
POST
/
ext
/
triggers
/
{triggerId}
Trigger a workflow
curl --request POST \
  --url https://triggers.app.pinkfish.ai/ext/triggers/{triggerId} \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '{}'
null

Documentation Index

Fetch the complete documentation index at: https://docs.pinkfish.ai/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
X-API-KEY
string
header
required

Headers

​
x-api-wait
enum<string>
default:false

Set to true for synchronous execution (waits up to 60 seconds for results). Set to false or omit for asynchronous (fire-and-forget) execution.

Available options:
true,
false

Path Parameters

​
triggerId
string
required

The unique identifier of the trigger

Query Parameters

​
myvar
string

Optional query parameter for the trigger

Body

The body is of type object.

Response

object | null

Workflow triggered successfully.

Async mode (x-api-wait: false): Response body is null. Use the X-Pf-Run-Id and X-Pf-Automation-Id headers to poll for results.

Sync mode (x-api-wait: true): Response body contains the full workflow results if completed within 60 seconds, or a timeout message with the run ID.

Sync mode: full workflow results. Async mode: null (check X-Pf-Run-Id and X-Pf-Automation-Id response headers).

​
automationId
string
​
automationVersion
integer
​
automationName
string
​
id
string

The run ID

​
type
string
​
results
object[]
​
started
string<date-time>
​
status
string