Skip to main content

Webhooks Overview

Webhooks allow you to receive real-time notifications about events happening in your Wing account. Instead of constantly polling our API for updates, webhooks push event data to your application whenever something important happens.

What are Webhooks?​

A webhook is an HTTP callback that gets triggered when a specific event occurs in your Wing system. When an event happens, we send a POST request to your configured webhook URL with JSON data describing the event.

Key Benefits​

  • Real-time Updates - Get instant notifications as events occur
  • Efficient - No need for continuous polling of the API
  • Reliable - Automatic retry logic ensures you don't miss events
  • Flexible - Configure which events you want to receive
  • Secure - Requests are signed for verification

How Webhooks Work​

  1. Create a Webhook Configuration - Register a URL where you want to receive events
  2. Subscribe to Events - Choose which event types you want to monitor
  3. Receive Events - Your endpoint receives POST requests when events occur
  4. Acknowledge Events - Respond with a 2xx status code to confirm receipt
  5. Handle Retries - If delivery fails, we automatically retry

Getting Started​

Common Use Cases​

  • Order Updates - React immediately when orders are created or status changes
  • Fulfillment Notifications - Track fulfillment order progress in real-time
  • Synchronization - Keep your systems in sync with Wing data
  • Alerts - Send notifications to your team when important events occur
  • Analytics - Track and analyze event data for insights

API Reference​

For detailed API endpoint documentation, see the API Reference section in the sidebar.