Skip to main content

WebhookEvent

Webhook event data structure

iduuid

The unique identifier of the event

Example: 123e4567-e89b-12d3-a456-426614174000
eventstring

Webhook event identifier

Possible values: [v1.collection.payment_request.created, v1.collection.payment_request.paid, v1.collection.payment_request.part_paid, v1.collection.payment_request.cancelled, v1.collection.payment_request.payment.created, v1.collection.payment_request.payment.pending, v1.collection.payment_request.payment.received, v1.collection.payment_request.payment.completed, v1.collection.payment_request.payment.failed, v1.collection.payment_request.payment.reversed, v1.collection.payment_request.payment.payout.pending_approval, v1.collection.payment_request.payment.payout.initiated, v1.collection.payment_request.payment.payout.paid, v1.collection.payment_request.payment.payout.failed]

createdAtdate-time

Created at timestamp of the event

Example: 2023-10-01T12:00:00Z
accountIduuid

The user account ID associated with the event

Example: 123e4567-e89b-12d3-a456-426614174001
relatedObject object

The related object that triggered the event

idstring

The id of the related object that caused the event

Example: 123e4567-e89b-12d3-a456-426614174002
typestring

The type of the related object that caused the event

Possible values: [collection.payment_request, collection.payment_request.payment, collection.payment_request.payment.payout]

Example: collection.payment_request
urlstring

The URL of the related object that caused the event

data object

Event-specific properties. The structure varies by event type:

v1.collection.payment_request.*:

{}

v1.collection.payment_request.payment.*:

{
  "paymentRequestId": "8a282576-18c0-4c0e-b158-44b92eda1afe"
}

v1.collection.payment_request.payment.payout.*:

{
  "paymentRequestId": "8a282576-18c0-4c0e-b158-44b92eda1afe",
  "paymentId": "9b393687-29d1-5d1f-c269-55c03fda2bfb",
  "transactionReference": "TX123456789"
}
oneOf
WebhookEvent
{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "event": "v1.collection.payment_request.created",
  "createdAt": "2023-10-01T12:00:00Z",
  "accountId": "123e4567-e89b-12d3-a456-426614174001",
  "relatedObject": {
    "id": "123e4567-e89b-12d3-a456-426614174002",
    "type": "collection.payment_request",
    "url": "string"
  }
}