Webhook Overview¶
Webhooks let ALPHA send event notifications to your HTTPS endpoint when business events occur.
Before You Start¶
-
Configure webhooks in the ALPHA Portal.
-
Ensure your endpoint is publicly reachable over HTTPS.
-
Store your webhook secret securely. ALPHA portal shows it once at creation and never again.
Important
Process webhook deliveries asynchronously in your system. Return a fast
2xx response after you have durably accepted the event, then do the
the processing background. This minimises retries.
Quick Start¶
-
Register an endpoint in the ALPHA Portal. See Webhook Endpoint Configuration.
-
Subscribe to the event types you need. See Webhook Events for the current list.
-
Verify
webhook-signature(Standard Webhooks) before processing the payload. See Webhook security. -
Handle events idempotently using the event
id. -
Return
2xxquickly after accepting the event.
Supported event types¶
ALPHA currently publishes the following event type:
-
packing_instructions.ready— sent when an order’s packing instructions are ready to download.
See Webhook Events for the full envelope and per-event data fields.
Delivery Flow¶
-
You register an endpoint in the ALPHA Portal and subscribe to events.
-
ALPHA sends an HTTP
POSTrequest to your endpoint when the event occurs. -
ALPHA retries transient failures up to 4 total attempts. See Webhook Deliveries for the schedule.
Scope and Isolation¶
-
Endpoints are scoped to your group.
-
Only active endpoints subscribed to the event receive notifications.
-
Delivery history is available in the ALPHA Portal.
Endpoint Requirements¶
-
Publicly reachable HTTPS URL
-
Accepts HTTP
POSTwith a JSON body -
Responds within 10 seconds
-
Returns
2xxonce the event has been accepted
Tip
Keep your handler idempotent from day one. Retries can happen for transient failures, network issues, or downstream timeouts.