Skip to main content
POST
/
integration-trigger
/
{id}
Trigger an integration tool
curl --request POST \
  --url https://api.postiz.com/public/v1/integration-trigger/{id} \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "methodName": "audioSearch",
  "data": {
    "q": "summer vibes",
    "type": "music"
  }
}
'
{
  "output": [
    {
      "id": "587784541076604",
      "title": "Summer Vibes",
      "artist": "Some Artist",
      "image": "https://scontent.cdninstagram.com/cover.jpg",
      "duration": 30000,
      "previewUrl": "https://scontent.cdninstagram.com/preview.mp4"
    }
  ]
}
Some providers expose helper tools for fetching dynamic data needed when constructing post settings — for example searching Instagram audio to attach to a Reel, listing Discord channels, or fetching Reddit flairs. Discover the tools available for a channel with the settings endpoint — each tool entry contains the methodName to pass here together with its parameter schema.

Authorizations

Authorization
string
header
required

Your Postiz API key

Path Parameters

id
string
required

The integration ID

Body

application/json
methodName
string
required

The tool method name, as returned by the integration settings endpoint

data
object

Key-value parameters for the tool

Response

Tool executed successfully

output
any

The tool result, shape depends on the tool