Configure endpoints#

This page explains how to register webhook endpoints in the Portal for your environment (see Base URLs) so ALPHA can deliver events to your server, for example when packing instructions are ready.

Get started#

  1. Create an HTTPS handler that accepts POST requests with a JSON body.

  2. Register the endpoint URL in the Portal and subscribe to event types (see Event types).

  3. Store the webhook signing secret shown at creation. The Portal shows it once.

  4. Verify webhook-signature on every delivery (see Verify signatures).

  5. Return 2xx quickly after you have durably accepted the event, then process work asynchronously.

Tip

Keep handlers idempotent from day one. Retries can deliver the same event id more than once. See Deliveries.

Endpoint settings#

Field

Type

Description

Endpoint URL

string

Required. Prefer HTTPS. Use a dedicated URL for ALPHA webhooks.

Event subscriptions

enum

Required. Select at least one type from Event types.

Active

boolean

Whether the endpoint currently receives deliveries.

Description

string

Optional. Metadata for your team.

Note

Endpoints are scoped to your group. Duplicate URLs in the same group are not allowed.

From the Portal you can enable or disable an endpoint, update its URL or description, change subscriptions, or send a test delivery.

Send a test delivery#

From the endpoint row menu, choose Send test.

Important

The test uses the same JSON envelope and Standard Webhooks headers as production. It always sends packing_instructions.ready with synthetic data (for example order_id 0 and reference ALPHA-TEST). It creates a new event; it does not replay a failed production delivery.

See also#

Event types

Envelope shape and packing_instructions.ready.

Event types
Verify signatures

How to verify webhook-signature.

Verify signatures