Webhooks let you receive real-time HTTP notifications whenever key events occur in your Batch Relay account — such as when a print order is created, validated, or submitted to a fulfillment partner. Instead of polling the API for status changes, you register an endpoint on your server and Batch Relay pushes event payloads to it automatically.Documentation Index
Fetch the complete documentation index at: https://docs.batchrelay.com/llms.txt
Use this file to discover all available pages before exploring further.
Webhooks are an upcoming feature currently planned for API accounts. The
events listed below represent the initial candidates and are subject to change
before general availability. Watch the developer dashboard and changelog for
launch announcements.
Planned Events
The following events are candidates for the first webhook release. Each event name follows aresource.action convention so you can filter and route them easily on your end.
print_order.created
print_order.created
Fired when a new print order is created in your account. Use this event to
begin tracking an order in your own system as soon as it exists in Batch
Relay.
print_order.validated
print_order.validated
Fired when a print order passes all validation checks and is ready to
proceed. This is a good signal to confirm the order details with your
customer.
print_order.validation_failed
print_order.validation_failed
Fired when a print order fails one or more validation checks. The event
payload will include details about what went wrong so you can surface
actionable feedback to the end user.
print_order.billing_required
print_order.billing_required
Fired when a print order cannot proceed until billing information is
confirmed or updated on the account.
print_order.billing_authorized
print_order.billing_authorized
print_order.imported
print_order.imported
Fired when a print order has been fully imported into the Batch Relay
fulfillment pipeline and is queued for submission.
print_order.submitted
print_order.submitted
Fired when a print order has been submitted to the fulfillment partner.
This typically means production has begun or is imminent.
print_order.failed
print_order.failed
Fired when a print order encounters a fatal error during processing and
cannot be automatically recovered. You should inspect the order and take
corrective action.
Delivery Records
Once webhook management is enabled, every delivery attempt — including the request payload, response status, and any errors — will be visible from your developer dashboard. You can use these records to debug failed deliveries, replay events, and monitor your endpoint’s health over time.Webhook management, including endpoint registration and delivery history, will
be available directly in the developer dashboard when the feature launches.
No additional tooling is required.