Webhooks
Send order and inventory updates to your application, inspect deliveries, and retry failures.
Subscribe an HTTPS endpoint to ShipOS events so your application can react when orders, inventory, or other records change.
Create a webhook
- Open Settings → Webhooks (opens the Cybership dashboard in a new tab) and choose Create Webhook.
- Enter the Endpoint URL and a Contact Email. The contact is told by email if the endpoint keeps failing.
- Under Event Subscriptions, select All Events or the individual events your application needs.
- Choose Create Webhook, then save the secret that appears. It is shown once; do not put it in client code or logs.
An endpoint URL must be unique within the team. Check the available topics and payloads before selecting events. Give your developer the webhook integration reference for signature verification and duplicate handling.
Webhook status
| Status | Meaning |
|---|---|
Active | Events are sent to the endpoint. |
Paused | You deactivated the endpoint. Events that happen while it is paused are not sent to it. |
Recovery Pending | The endpoint kept failing, so ShipOS stopped sending to it. It tries one delivery an hour until the endpoint answers successfully, then sends everything that is waiting. |
Inspect and retry deliveries
Choose View Logs for the endpoint to see its deliveries. Select a delivery, or choose View Details, to see each attempt with its response status and what went wrong. Use Older attempts to go further back. Choose Details on an attempt to see the request and response. Passwords, keys and other credentials are hidden; expired details are marked.
Event payloads and request and response details are kept for 7 days, and delivery history for 30 days.
After fixing your receiver, choose Replay failed deliveries to review and confirm a batch. The result shows which deliveries were queued or skipped. Already-successful and pending deliveries are skipped. Replay keeps the original event ID, so your receiver must still check for duplicates. Deliveries with expired payloads cannot be replayed.
Pause and recover
Choose Deactivate Webhook to stop sending events to an endpoint, and Activate Webhook when it can receive them again. Events that happen while the endpoint is paused are not sent to it. Deliveries that were already waiting are sent after you activate it, unless they are more than three days old.
If an endpoint shows Recovery Pending, fix your receiver and choose Activate Webhook. The next waiting delivery is tried straight away instead of at the next hourly check. See the integration reference for timing and retry limits.
Replace a signing secret
Choose Replace Secret only when you need to change the key. Confirming pauses the endpoint and replaces the old secret immediately. Events that happen before you activate it again are not sent to it. Save the new secret, have your developer update the receiver, then choose Activate Webhook. There is no automatic rotation schedule.
Permissions
- Read Webhooks: view endpoints, delivery logs and attempt details.
- Write Webhooks: create and edit endpoints, test, activate, deactivate, replace secrets and replay deliveries.
- Delete Webhooks: delete endpoints.