shipink-logo-vector-svgDocumentation

Webhook Notifications

Receive shipment status updates in your system through webhooks.

Note: Webhook notifications are available on Pro and higher plans. On other plans the tab carries a "Pro and higher" label, and clicking anything in it opens an upgrade prompt.

1. Go to Notifications

Click the Settings gear icon in the top right, then click Notifications in the left menu, then open the Webhook tab.

2. Enter Your Webhook URL

Enter the Endpoint URL where Shipink should send events. The URL is required as soon as one event is selected, and it must be a valid http or https address.

Optionally, enter a Signing secret. When it is set, each request is signed so you can verify it came from Shipink (see Verifying requests).

3. Choose Which Events to Send

Pick which stages trigger a webhook, the same way you would for email or SMS. The available events, all under the Shipment heading, are:

  • When the carrier has received the shipment
  • When the package is out for delivery
  • When the package is delivered
  • When the package is delayed

4. Save

Click "Bildirim tercihlerini güncelle" (Update notification preferences) to apply your settings.

Verifying requests

Each event is delivered as a POST request to your URL. When you set a signing secret, the request carries an X-Shipink-Signature header: the body signed with your secret using HMAC-SHA256. Recompute the signature on your side and compare it to reject any request that was not sent by Shipink. Delivery is retried a few times if your endpoint does not respond.

Was this page helpful?

On this page