Skip to main content
POST
/
ext
/
webhook
/
{apiKey}
/
triggers
/
{triggerId}
Trigger a workflow via webhook
curl --request POST \
  --url https://triggers.app.pinkfish.ai/ext/webhook/{apiKey}/triggers/{triggerId} \
  --header 'Content-Type: application/json' \
  --data '
{
  "event": "issue_created",
  "issue_id": "12345"
}
'
{
  "error": "<string>",
  "message": "<string>"
}

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.

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

​
apiKey
string
required

The API key for authentication (embedded in URL)

​
triggerId
string
required

The unique identifier of the trigger

Body

application/json

The body is of type object.

Response

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.