Skip to main content
POST
/
workflows
/
webhook
/
{path...}
{
  "workflowTaskIds": [
    "f47ac10b-58cc-4372-a567-0e2b2c3d479"
  ],
  "workflowTasks": [
    {
      "workflowTaskId": "f47ac10b-58cc-4372-a567-0e2b2c3d479",
      "name": "Reward customer with data top-up",
      "description": "Rewards a customer's subscription with the specified data top-up product offering.",
      "createdAt": "2024-01-15T10:35:00Z"
    }
  ]
}

Authorizations

​
X-API-Key
string
header
required

An API key that grants access to the Connect API. You can create and manage API keys in the portal.

Headers

​
X-Idempotency-Key
string

A unique key to ensure idempotency of requests. If a request with the same key has already been processed, the same result will be returned. The key must be unique for each distinct operation. Keys are expired after 24 hours, but we recommend using a new key for each request.

Modified requests with the same idempotency keys are rejected with a 409 Conflict status code.

Maximum length: 256

Path Parameters

​
path...
string
required

The wildcard webhook path to match against registered workflows. Leading slashes in the workflow registration are ignored, so support/intents/reward/topup and /support/intents/reward/topup are equivalent.

This is a greedy path parameter, meaning it captures the entire remainder of the URL path.

Body

application/json · object

The webhook payload. Can be any valid JSON object. The payload data is passed to the matching workflow(s) which can access and use any properties from it.

Any valid JSON object. The payload determines what data is available to the workflow.

Response

Webhook successfully delivered to at least one registered workflow.

​
workflowTaskIds
string[]
required

List of workflow task IDs that were triggered by this webhook.

​
workflowTasks
object[]
required

List of workflow tasks that were triggered by this webhook.

⌘I