Skip to main content
All events use the common webhook envelope. The type identifies the event and data contains the affected resource.

Test

The test event contains {"message":"This is a test webhook from BillingServ."}.

Payments

Payment data fields:

Customers

Customer data contains id, name, email, username, vat_number, email_verified_at, created_at, updated_at, and deleted_at.

Invoices

Invoice data fields: An invoice becoming paid can produce both invoice.updated and invoice.paid. Handle each event ID independently.

Orders and subscriptions

Order and subscription data contains id, customer_id, package_id, cycle_id, price, currency_id, status, domain_name, cancellation_type, reason, last_invoice, next_invoice, cancelled_at, created_at, updated_at, and deleted_at. price is a money string. An order cancellation can produce both order.updated and subscription.cancelled.

Credit notes

Credit note data contains id, credit_note_number, invoice_id, customer_id, amount, tax_amount, currency_id, reason, added_to_account_credit, issued_at, created_at, and updated_at. Amounts are money strings.

Support

Ticket data contains id, customer_id, order_id, subject, status, priority, department, assignee_id, contact_name, email_address, last_action, sla_due_at, first_response_at, created_at, and updated_at. Ticket message data contains id, ticket_id, author_id, message, and created_at. The message can contain sanitized HTML and should be escaped or sanitized before rendering in your own interface.