Skip to main content
WEBHOOK
custom.workflow_triggered
{
  "eventId": "b3a2d5c4-1f2e-4a6b-9c7d-1234567890ab",
  "type": "<string>",
  "occurredAt": "2023-11-07T05:31:56Z",
  "data": [
    {
      "key": "<string>",
      "value": "<string>"
    }
  ]
}

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.

Body

application/json
eventId
string<uuid>
required

Unique identifier for this event (stable for the logical event; multiple delivery attempts reuse the same id). Use for idempotency.

Example:

"b3a2d5c4-1f2e-4a6b-9c7d-1234567890ab"

type
string
required

The event type identifier.

occurredAt
string<date-time>
required

RFC 3339 timestamp when the underlying change occurred.

data
object[]
required

A list of key value pairs.

Response

Acknowledged