On this page
No Headings
objectidrequiredstringUnique identifier for the webhook event.
create_timerequiredobjectdate-timeTime when the webhook event was created.
event_versionstringVersion of the event schema.
summarystringBrief description of the event.
resource_versionstringVersion of the resource schema.
linksarrayHATEOAS links for the webhook event.
itemsobjecthrefrequiredstringuriURL for the action.
relrequiredstringRelation type of the link.
methodrequiredstringHTTP method to use with the URL.
resource_typerequiredstring"subscription-alert", "wallet", "wallet-transaction", "credit-note", "invoice", "subscription"Type of resource that triggered the webhook.
event_typerequiredstring"USAGE-BILLING.SUBSCRIPTION-ALERT.TRIGGERED", "USAGE-BILLING.WALLET.CREATED", "USAGE-BILLING.WALLET.UPDATED", "USAGE-BILLING.WALLET.NET-BALANCE-DEPLETED", "USAGE-BILLING.WALLET.TERMINATED", "USAGE-BILLING.WALLET-TRANSACTION.CREATED", "USAGE-BILLING.WALLET-TRANSACTION.UPDATED", "USAGE-BILLING.CREDIT-NOTE.CREATED", "USAGE-BILLING.CREDIT-NOTE.REFUND.FAILED", "USAGE-BILLING.INVOICE.CREATED", "USAGE-BILLING.INVOICE.PAYMENT.OVERDUE", "USAGE-BILLING.INVOICE.PAYMENT.SUCCEEDED", "USAGE-BILLING.INVOICE.PAYMENT.FAILED", "USAGE-BILLING.SUBSCRIPTION.UPDATED", "USAGE-BILLING.SUBSCRIPTION.TERMINATED", "USAGE-BILLING.SUBSCRIPTION.TRIAL.ENDED"Type of event that occurred in webhooks.