Custom workflow triggered

Sent from within a workflow and content is defined by the workflow configuration.

WEBHOOK custom.workflow_triggered

Example

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

Authorizations

apiKeybearerAuth & apiKey

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.

Allowed value: "custom.workflow_triggered"

occurredAt · string<date-time> · required

RFC 3339 timestamp when the underlying change occurred.

data · object[] · required

A list of key value pairs defined by the workflow configuration. Always includes a "customType" entry with the custom event type (e.g. "telna.esim_status_change").

Show child attributes

Response

200

Acknowledged