The webhook endpoint object

{
  "lago_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
  "lago_organization_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
  "webhook_url": "https://foo.bar",
  "signature_algo": "hmac",
  "name": "EC2-production",
  "event_types": [
    "invoice.voided",
    "customer.created"
  ],
  "created_at": "2022-04-29T08:59:51Z"
}

lago_id

string<uuid>

required

Unique identifier assigned to the webhook endpoint within the Lago application. This ID is exclusively created by Lago and serves as a unique identifier for the webhook endpoint's record within the Lago system.

Example:

"1a901a90-1a90-1a90-1a90-1a901a901a90"

lago_organization_id

string<uuid>

required

Unique identifier assigned to the organization attached to the webhook endpoint within the Lago application. This ID is exclusively created by Lago and serves as a unique identifier for the organization's record within the Lago system.

Example:

"1a901a90-1a90-1a90-1a90-1a901a901a90"

webhook_url

string

required

The URL of the webhook endpoint.

Example:

"https://foo.bar"

signature_algo

enum<string>

required

The algorithm used to sign the webhook payload.

Available options:

jwt,

hmac

Example:

"hmac"

name

string | null

required

The name of the webhook endpoint.

Example:

"EC2-production"

event_types

string[] | null

required

The list of event types sent to this webhook endpoint. When the value is null, every event type is sent. When the value is an empty array, no event is sent.

Example:

["invoice.voided", "customer.created"]

created_at

string<date-time>

required

The date of the webhook endpoint creation, represented in ISO 8601 datetime format and expressed in Coordinated Universal Time (UTC).

Example:

"2022-04-29T08:59:51Z"