Attributes

id string(36)
Unique identifier for the object.

url string(64)
The URL of the webhook endpoint.

description string(64)
An optional description of what the webhook is used for.

events string[]
The list of events to enable for this endpoint.

secret string(64)
The endpoint’s secret, used to generate webhook signatures.

status enum
The status of the webhook endpoint. Can beACTIVE, INACTIVE or DELETED.

Status	Description
`ACTIVE`
`INACTIVE`
`DELETED`

createdAt datetime
Time at which the object was created.

updatedAt datetime
Time at which the object was updated.

deletedAt datetime
Time at which the object was deleted.

Example

{
  "id": "ea816523-d73e-4c58-a1c1-2f3c5758a1b7",
  "url": "https://my.back.end/webhooks",
  "description": null,
  "events": [ "payment.paid" ],
  "secret": "62cab3d1aca75122cebbf26769a20b4dc32a33d0131d6c323834e677532ae73a",
  "status": "ACTIVE",
  "createdAt": "2022-06-08T15:02:00Z",
  "updatedAt": null,
  "deletedAt": null,
}