Webhooks

Subscribe an HTTPS endpoint to ShipOS events so your application can react to operational changes.

Creating a Webhook Endpoint

1. Open Settings → Webhooks (opens the Cybership dashboard in a new tab) and choose Create Webhook.
2. Enter the endpoint URL, description, and contact email.
3. Select event patterns: * for all events, a category such as orders/*, or an exact event such as orders/created.
4. Save and securely store the generated secret. Do not put it in client code or logs.

An endpoint URL must be unique within the team. See available topics and payloads before selecting events.

Receiving Events

Verify signatures against the original request body before processing data, reject invalid or stale requests, and deduplicate using the event ID. Save accepted work durably before responding with a successful status; process longer tasks asynchronously.

Use the webhook integration reference for receiver implementation. Payloads vary by event, so use the selected topic's documented shape.

Monitor and Retry

Open the endpoint to inspect delivery history, response status, and errors. Fix receiver failures before retrying failed deliveries; retries can deliver an event more than once.

Check that the endpoint is active and its event patterns include the expected event. If it is paused or disabled, resolve the underlying issue before re-enabling it. Delivery history is the place to investigate retries and failures.