HomeDocumentationAPI endpointsChangelog
HomeStatusSupportLog In
API endpoints

Webhook

The Webhook resource contains information about the configuration of the webhook endpoint. We recommend setting this up through our GUI within the Developer section of Billetto.

The Webhook object

idstringThe unique Webhook ID.
objectstringThe object type name, set to "webhook".
namestringThe Webhook name.
urlURLThe Webhook endpoint URL.
event_namesarray or stringThe list of event names that triggers webhook events.
enabledbooleanThe status of the Webhook.
secretslistThe list object with collection of Webhook Secret resources.
versionstringThe API version that is used to generate Webhook events' payload.
applicationstring (expandable)

The Webhook Application ID.

Expands to the Application resource.

Webhook Events:

event.createdtriggered when a Billetto event is created
event.published:triggered when a Billetto event is published
event.unpublishedtriggered when a Billetto event is unpublished
event.completedtriggered when a Billetto event is completed
event.cancelledtriggered when a Billetto event is cancelled
event.updatedtriggered when a Billetto event is updated
order.completedtriggered when a ticket buyer completes an order (confirms a free order or complete the payment for a paid order)
order.refundedtriggered when an order is refunded (either partially or fully)
order.cancelledtriggered when an order is cancelled
order.updatedtriggered when order details change (e.g. custom fields are filled in, customer address is provided, etc.)
attendee.registeredtriggered when a ticket buyer completes the order and the ticket is created
attendee.cancelledtriggered when an attendee ticket is cancelled
attendee.updatedtriggered when there is a change in the attendee (seat is swapped, a ticket is transferred, etc.)
attendee.scannedtriggered each time the barcode of attendee's ticket is scanned using Billetto app
attendee.generatedtriggered when a ticket is generated by the organiser
ledger_entry.createdtriggered when a new ledger entry is created on your account