Handle Webhooks

Aerosync Webhooks

Integration Guide

This guide explains how to subscribe to Aerosync webhooks, verify requests, and handle events in your application. It covers endpoints for managing subscriptions and the event payloads you will receive.

Notes

  • Delivery model: at-least-once
  • Transport: HTTPS POST with JSON body
  • Security: optional HMAC-SHA256 signature header when you set a secret_key
  • Retries: up to 3 attempts with exponential backoff on non-2xx or timeout
  • Auto-pause: after 5 consecutive delivery failures; you can unpause via API

Base URL

Note: In examples below, replace {API_BASE_URL} with the appropriate base URL.

Quick Start

  1. Expose a public HTTPS endpoint in your system that accepts POST requests with JSON
  2. (Recommended) Choose and store a secret key you will use to verify signatures
  3. Create a webhook subscription via our API (see Subscribe endpoint)
  4. Verify delivery with the Test endpoint
  5. Start receiving real-time events