For the complete guide to webhooks, visit the Webhooks page for the API you are using:

Automation API

Commerce API

Available webhooks

order_batch.createdWhen an order batch is newly created. The order batch could still be in process of sending, or scheduled for the future.
order_batch.completedWhen an order batch is fully processed and all orders have been created.
order.createdWhen an order is created and is ready to be opened.
order.gift_openedWhen a gift is opened by the recipient.
order.gift_acceptedWhen a gift has been accepted by the recipient.
order.thank_you_note_addedWhen a recipient adds a thank you note to a order after accepting it.
order.shippedWhen an order starts shipping. If there are multiple shipments, this is called for the first.
order.deliveredWhen an order is fully delivered. If there are multiple shipments, this is called when all shipments are delivered.
order.canceledWhen an order has been canceled.
order.refundedWhen an order has been refunded.

Setting up a new webhook

Enter a URL to recieve webhooks in the Endpoint URL section.

You can leave Message Filtering blank to receive all events, or select specific events to receive.

Webhook security

To ensure the integrity of the webhooks you receive, we recommend verifying the signatures of the webhooks you receive. Svix provides packages for multiple languages that make verifying signatures easy.

To see how, go to the Webhook Security page.


You can view the logs for webhook delivery for each endpoint, and re-send any failed webhooks if needed.