Webhooks Overview

Webhooks notify your application when something happens to your orders and parcels in Wing. Instead of polling our API, you register an endpoint and subscribe to the events you care about: Wing sends a POST request with a JSON body to that endpoint whenever one of them occurs.

How Webhooks Work

1. Create a webhook configuration: give it a name, the endpoint to call and the events to subscribe to.
2. Receive events: your endpoint receives a POST request for every subscribed event.
3. Acknowledge: answer with any 2xx status code.
4. Retries: a non-2xx answer is retried later, with an increasing delay (see Configuring Webhooks).

Events

You subscribe to event types named after what happened, such as order.packed or parcel.updated. The full list, with the data each one carries, is in Events & Payloads.

Getting Started

• What are Webhooks?: concepts
• Events & Payloads: the available events and their payloads
• Configuring Webhooks: create and manage your webhook configurations

API Reference

Every endpoint is documented in the API Reference section of the sidebar.