Skip to main content
WEBHOOK
challengesInitialize
{
  "subscriptionId": "c4d1da72-111e-4d52-bdbf-2e74a2d803d5",
  "notificationId": "c4d1da72-111e-4d52-bdbf-2e74a2d803d5",
  "notificationType": "challenges.initialize",
  "notification": {
    "id": "c4d1da72-111e-4d52-bdbf-2e74a2d803d5",
    "status": "PENDING",
    "type": "SET_PIN",
    "correlationIds": [
      "54399e5a-1bf6-4921-9559-10c1115678cd"
    ],
    "errorCode": 155121,
    "errorMessage": "challenge expired"
  },
  "timestamp": "2023-11-07T05:31:56Z",
  "version": 123
}

Body

application/json

Envelope sent to your endpoint for every webhook notification. The shape of the notification field depends on notificationType.

​
subscriptionId
string<uuid>
required

ID of the webhook subscription that produced this notification.

Example:

"c4d1da72-111e-4d52-bdbf-2e74a2d803d5"

​
notificationId
string<uuid>
required

Unique ID for this event notification. Stable across retries of the same event.

Example:

"c4d1da72-111e-4d52-bdbf-2e74a2d803d5"

​
notificationType
enum<string>
required

The type of notification.

Available options:
challenges.initialize
​
notification
object
required

The event payload. The schema of this object depends on notificationType.

​
timestamp
string<date-time>
required

When the notification was produced.

​
version
integer
required

The version of the notification schema.

Response

200

Webhook received successfully.