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>"
}

Triggers API

Trigger a workflow via webhook

Executes a workflow using a webhook URL with the API key embedded in the path. Designed for third-party services that cannot set custom headers (Slack, Discord, Linear, Zoom, etc.).

Supports the same two execution modes as the API trigger:

Asynchronous (default): Returns immediately with an empty (null) response body. Use X-Pf-Run-Id and X-Pf-Automation-Id response headers to poll for results.
Synchronous: Set x-api-wait: true. Waits up to 60 seconds for results.

Note: Webhook triggers support JSON and form-encoded data only. File attachments are not supported.

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>"
}

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.

Trigger a workflow Overview

⌘I

Documentation Index

Headers

Path Parameters

Body

Response