Skip to main content
All featuresDevelopers

Webhooks

Send record changes to your own endpoint as they happen. Each webhook watches one record type for created, updated or deleted events. Deliveries are signed with HMAC-SHA256, and every attempt shows in the delivery history.

How ShipGenius differs

Each webhook can be narrowed to the fields you care about, a condition, a saved filter or one integration, so your endpoint only gets the events it needs. Disabling a webhook queues its deliveries instead of dropping them.

How it works

Webhooks belong to an app. Add one from the Webhooks section on the app's page with a public https endpoint, then choose what to watch. Deliveries are signed and expect a 2xx response within 10 seconds.

Choose what to watch

  • Entity type and event: one record type, and the event to send: created, updated or deleted.
  • Only when these fields change: for updates, pick the fields that matter. Leave it empty to match any update.
  • Condition: compare fields, or pick a saved filter from a list page so only matching records send.
  • Only from integration: limit events to one marketplace integration.

Signing secrets

When you save a webhook, its signing secret is shown once. Copy it before you close the dialog. Each delivery carries an HMAC-SHA256 signature of the timestamp and body in the X-ShipGenius-Signature header, and you check it with that secret. If the secret is lost, rotate it to get a new one.

Pause and delivery history

Disable a webhook and matching deliveries queue up. They post once you enable it again. Each webhook keeps its delivery history, newest first, with the status, event, attempts, last HTTP status code and last error. Open any delivery to see its full record.

Webhooks are managed on the same app as your API keys. Read more in API keys and connected apps.