API Reference
Cabify BusinessAPI Support

Subscribe to parcel update notifications.

post
https://logistics.api.cabify-sandbox.com/v1/webhooks

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.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

The webhook subscription details, including the event type and your callback URL.

string
enum
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.

Allowed:
uri
required

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

headers
array of objects

Custom headers to include in every webhook request sent to your endpoint (e.g. for authentication).

headers
Responses
201

Webhook subscription created successfully.

401

Unauthorized. Missing or invalid authentication token.

429

Too many requests. This API is rate limited per account and per endpoint. A 429 is an expected condition rather than a failed request: back off and retry it. The limits are not the same for every endpoint and can change, so handle the status instead of hard-coding a rate. See the Limits and reliability guide.

Callbacks

Updated 5 months ago

Did this page help you?
Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 5 months ago

Did this page help you?