CAcabify
webhooks

Subscribe to parcel update notifications.

Register a webhook to receive real-time notifications when parcels are updated.

Securing your webhook endpoint:

  1. Include a custom authorization header in the subscription request. Our API will forward it with every notification: 
    Authorization: Bearer <your-auth-token>
  2. For enhanced security using OAuth (client credentials), contact us to set up authentication with a clientId and clientSecret.
post/v1/webhooks

Request

  • Base URL
    https://logistics.api.cabify-sandbox.com
  • URL
    https://logistics.api.cabify-sandbox.com/v1/webhooks
  • Auth
    HTTP bearer

Request body

hook'parcel' | 'parcelLocation' | 'proofCodeGenerated' required

The event type to subscribe to: - parcel: Triggered on every parcel status change. - parcelLocation: Triggered when the driver's location is updated. - proofCodeGenerated: Triggered when a proof of delivery code is generated for a parcel.

callback_urlstring uri required

Your endpoint URL. The API will send a POST request to this URL each time the subscribed event occurs.

Example request

{
  "callback_url": "http://example.com/your/callback/here",
  "headers": [
    {
      "name": "Authorization",
      "value": "Bearer 000111222333444"
    }
  ]
}

Response

Webhook subscription created successfully.

Changes

No recorded changes to this operation across all 1 revision of this API.