Skip to main content
WEBHOOK

Headers

Webhook-Id
string<uuid>
required

Unique event ID. Matches the payload id and can be used as an idempotency key.

Webhook-Event
enum<string>
required

Event name. Matches the payload type.

Available options:
webhook.test,
payment.succeeded,
payment.failed,
customer.created,
customer.updated,
customer.deleted,
customer.restored,
order.created,
order.updated,
order.deleted,
order.restored,
subscription.cancelled,
subscription.renewed,
invoice.created,
invoice.updated,
invoice.paid,
invoice.deleted,
invoice.restored,
credit_note.created,
credit_note.updated,
credit_note.deleted,
support_ticket.created,
support_ticket.updated,
support_ticket.deleted,
support_ticket.message_created

Body

application/json

Common envelope used for every outbound BillingServ webhook.

id
string<uuid>
required

Unique event ID.

type
enum<string>
required
Available options:
webhook.test,
payment.succeeded,
payment.failed,
customer.created,
customer.updated,
customer.deleted,
customer.restored,
order.created,
order.updated,
order.deleted,
order.restored,
subscription.cancelled,
subscription.renewed,
invoice.created,
invoice.updated,
invoice.paid,
invoice.deleted,
invoice.restored,
credit_note.created,
credit_note.updated,
credit_note.deleted,
support_ticket.created,
support_ticket.updated,
support_ticket.deleted,
support_ticket.message_created
created_at
string<date-time>
required
data
object
required

Response

Event accepted