POST
/
trigger
/
Trigger Workflow
curl --request POST \
  --url https://hub.suprsend.com/trigger/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "workflow": "_workflow_slug_",
  "recipients": [
    {
      "is_transient": true,
      "distinct_id": "id1",
      "$email": {
        "value": "john@example.com"
      },
      "$sms": {
        "value": "+1234567890"
      },
      "$webpush": {
        "value": "webpush_token_abc123"
      },
      "$inbox": {
        "value": "4nlPk4t4kurG5kChOELB8Q1LcDI9DHzHQ70st2E2C24",
        "id_provider": "suprsend"
      },
      "$androidpush": {
        "value": "android_push_token_xyz987"
      },
      "$iospush": {
        "value": "ios_push_token_lmn456"
      },
      "$slack": {
        "value": "U01ABCDE2F3"
      },
      "$ms_teams": {
        "value": "teams_user_id_123456"
      },
      "$timezone": "America/New_York",
      "$preferred_language": "en"
    }
  ],
  "actor": {
    "is_transient": true,
    "distinct_id": "id1"
  },
  "data": {
    "$attachments": [
      {
        "url": "https://bitcoincore.org/bitcoin.pdf",
        "filename": "billing.pdf",
        "ignore_if_error": true
      }
    ]
  },
  "tenant_id": "<string>",
  "$idempotency_key": "<string>"
}'
{
  "status": "success"
}

Authorizations

​
Authorization
string
header
required

Pass as Bearer <API_KEY>. Get API Key from SuprSend dashboard Developers -> API Keys section.

Body

application/json

Response

202
application/json

202 - Accepted

All workflow requests will be accepted as long as the API request is correct. To verify if the execution was successful, check the 'Requests' tab under the 'Logs' section on the SuprSend dashboard.