Webhook

description
Type: string
required

What the event means.
enabled
Type: boolean
required

Whether the event is delivered. Off until you switch it on.
id
Type: string
required

The webhook's ID.
lastSentAt
Type: string | nullFormat: date-time
required

When the last delivery attempt (a retry or a test delivery included) was sent; null if never.
lastStatus
Type: "success" or "failed" or nullenum
required

success when your endpoint answered the last delivery attempt with a 2xx; failed otherwise; null if never sent.
name
Type: enum
required

A billing event you can receive. billing-invoice-paid, billing-invoice-posted, billing-invoice-refunded, billing-checkout-created, billing-checkout-completed, billing-checkout-expired, billing-payment-succeeded, billing-payment-failed, billing-credits-depleted, billing-overage-incurred and billing-credit-cap-reached; each is described in the Webhooks section.
values
- billing-invoice-paid
- billing-invoice-posted
- billing-invoice-refunded
- billing-checkout-created
- billing-checkout-completed
- billing-checkout-expired
- billing-payment-succeeded
- billing-payment-failed
- billing-credits-depleted
- billing-overage-incurred
- billing-credit-cap-reached
url
Type: string | nullFormat: uri
required

Where the event is delivered; null until you set it.