The webhook endpoint object

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

lago_id

string<uuid>

required

Unique identifier assigned to the wallet 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"

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"

signature_algo

enum<string>

The signature algo for the webhook.

Available options:

jwt,

hmac

Example:

"hmac"

name

string | null

The name of the webhook.

Example:

"EC2-production"

event_types

string[] | null

A list of event types that will trigger the webhook. Passing null means that all event types will be sent.

Example:

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

⌘I