Webhooks Reference
Webhook events are triggered by key actions and changes within Advanced Billing, providing notifications about billing, subscription, payment, and account activities. Each event includes a structured payload with relevant data, allowing you to automate workflows, synchronize systems, or log activity for auditing and analysis.
If you’re using the enhanced Catalog experience, you’ll see updated naming in webhook events and messages.
Event name changes:
- subscription_product_change → subscription_plan_change
- component_allocation_change → allocation_change
- component_billing_date_change → product_billing_date_change
Message updates:
- “Successful payment for allocation changes to Product on Subscription”
- “Failed payment for allocation changes to Product on Subscription”
- “Plan changed on Subscription from previous plan to new plan”
Payloads
The resource objects sent as payloads typically contain the same information as the corresponding API resource. For example, Site payload objects include the site’s id and subdomain. However, not all values may be populated in the payload. Use discretion to determine whether the data is available and how to handle missing information. For example, the reason_code data is not delivered in a signup_success webhook.
Webhooks retain their event and payload data. Refer to the webhook API for detailed attribute documentation.
Webhook metadata
Webhook records include metadata about their acceptance or rejection by your application, as well as details about errors encountered during delivery attempts. Metadata attributes include:
- id: Unique identifier for the webhook, consistent across retries/replays.
- successful: Boolean indicating whether the webhook was accepted on its last attempt.
- created_at: Timestamp for when the webhook was created.
- accepted_at: Timestamp for when the webhook was successfully accepted Once a webhook is accepted, the accepted_at timestamp will be filled. This timestamp can be viewed via the Webhooks API or in the Webhooks panel, if available for your plan.
- last_sent_at: Timestamp for the most recent delivery attempt.
- last_error_at: Timestamp for the last failed delivery attempt.
- last_error: Description of the error from the last failed attempt.