Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Cabify webhooks API

Subscribe to event-driven notifications to receive live updates about parcel status changes, location updates, and proof of delivery codes.

Cabify webhooks API is one of 13 APIs that Cabify publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include webhooks. The published artifact set on APIs.io includes an OpenAPI specification, an API reference, and a changelog.

This API exposes 3 operations across 2 paths, and defines 15 schemas. It is described by OpenAPI 3.0.0, at version 1.0.0.

Requests are made against 2 base URLs: https://logistics.api.cabify.com, https://logistics.api.cabify-sandbox.com.

3 operations 2 paths 15 schemas 1 DELETE1 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
1.0.0
Base URL
https://cabify.com/api/v4
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Cabify webhooks API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (bearer_token).

Paths & Operations 3

Across 2 paths, the API surfaces 3 operations — 1 DELETE, 1 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

webhooks 3

Subscribe to event-driven notifications to receive live updates about parcel status changes, location updates, and proof of delivery codes.

DELETE
/v1/webhooks/{hook}
Unsubscribe from a webhook.
deleteWebhook 1 param → 200401
GET
/v1/webhooks
List your active webhook subscriptions.
getWebhook → 200401
POST
/v1/webhooks
Subscribe to parcel update notifications.
subscribeWebhook body → 201400401

Schemas 15

The contract defines 15 schemas that model the data the API accepts and returns. The most detailed are ParcelStatusHook (11 properties), PickupAttempt (7 properties), ResponseWebhookSubscription (4 properties), Asset (4 properties). Each schema is shown below with its type and property counts.

AssetKind
string
The type of vehicle assigned to carry the parcel.
ResponseWebhookSubscription
object
4 properties 3 required
PickupFailed
object
Deprecated. Use pickupattempt instead. Details of a failed pickup attempt.
3 properties
ParcelStatusHook
object
Payload sent to your webhook callback URL whenever a parcel's status changes.
11 properties
CommentProofOfPickUp
object
Written note left by the driver as confirmation of the pickup.
1 property
ParcelStatusRoute
object
Route information between two points during a delivery.
2 properties 2 required
ParcelLocation
object
Payload sent to your webhook callback URL with the driver's real-time location.
4 properties 3 required
Header
object
2 properties 2 required
WebhookSubscription
object
3 properties 2 required
RequestError
object
Standard error response body returned when a request fails.
1 property 1 required
PickupAttempt
object
Details of a pickup attempt, whether successful or not.
7 properties 3 required
PhotoProofOfPickUp
object
Photo evidence captured by the driver at the pickup location.
1 property
ResponseWebhookSubscriptions
object
1 property 1 required
Asset
object
Details of the vehicle assigned to the delivery.
4 properties
ProofCodeGenerated
object
Payload sent to your webhook callback when a proof of delivery code is generated for a parcel.
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

cabify-webhooks-api-openapi.yml Raw ↑

Other APIs Cabify publishes across the network.

Cabify delivery API
Cabify Estimates API
Cabify hubs API
Cabify Journeys API
Cabify label API
Cabify Labels API
Cabify parcels API
Cabify Sales API
Cabify shipment API
Cabify shipping_types API
Cabify status API
Cabify users API