Skip to main content
POST
Subscribe to webhooks

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Subscribe to webhooks and receive event notifications.

callbackUrl
string
required
eventType
enum<string>
required
Available options:
AnonymousCustomer,
Overage,
UpcomingRenewal,
ContractExpired,
InvoiceApproved,
CustomerPortalLinkSent,
NewCustomerWithoutContract,
MonthEndReport,
UnchargedEvents,
TierCrossed,
CommitmentCrossed,
CommitmentUsageCrossed,
CurrencyCommitmentUsageCrossed,
FinalTierExceeded,
InvoicePaymentStatusChanged,
ContractAnniversary,
InvoiceSendFailed,
CreditPoolDepleted,
CreditPoolThresholdCrossed,
CreditPoolIncreased,
PaymentFailed,
CustomerCreated,
ContractCreated,
InvoiceIssueDateArrived,
MeteringHealthDegraded,
EventsIngestionStopped,
PingTest
threshold
number
recurringThreshold
number

Response

RequestSuccess