Flexible Rides State Updates

These webhook updates will be dispatched whenever a Flexible Ride status is changed from the initial pending state.
There is a different event type and data on the dispatched messages, depending on the state change.

Claimed

A webhook of type flexible-ride-claimed is dispatched when a Flexible Ride status is set as claimed

The data payload of the webhook message contains the following fields:

FieldTypeDescription
client_idstringYour Cabify client identifier
flexible_ride_idstringThe flexible ride identifier
occurred_atstring (ISO 8601)When the flexible ride was claimed
journey_idstringIdentifier of journey created for flexible ride

Example Request

curl -X POST
    YOUR_WEBHOOK_URL
    -H 'Content-Type: application/json'
    -d '{
      "data":{
        "client_id":"512cc654f0e342efcdd3fdfde9fd8000",
        "flexible_ride_id":"3fad6e43719a48f3904b5f2d54865b1a",
        "journey_id":"3fad6e43719a48f3904b5f2d54865b1a",
        "occurred_at":"2026-08-17T08:11:52Z"
      },
      "type": "flexible-ride-claimed",
      "errors": []
    }'

Expired

A webhook of type flexible-ride-expired is dispatched when a Flexible Ride status is set as expired

The data payload of the webhook message contains the following fields:

FieldTypeDescription
client_idstringYour Cabify client identifier
flexible_ride_idstringThe flexible ride identifier
occurred_atstring (ISO 8601)When the flexible ride was expired

Example Request

curl -X POST
    YOUR_WEBHOOK_URL
    -H 'Content-Type: application/json'
    -d '{
      "data":{
        "client_id":"512cc654f0e342efcdd3fdfde9fd8000",
        "flexible_ride_id":"3fad6e43719a48f3904b5f2d54865b1a",
        "occurred_at":"2026-08-17T08:11:52Z"
      },
      "type": "flexible-ride-expired",
      "errors": []
    }'

Cancelled

A webhook of type flexible-ride-cancelled is dispatched when a Flexible Ride status is set as cancelled

The data payload of the webhook message contains the following fields:

FieldTypeDescription
client_idstringYour Cabify client identifier
flexible_ride_idstringThe flexible ride identifier
occurred_atstring (ISO 8601)When the flexible ride was cancelled

Example Request

curl -X POST
    YOUR_WEBHOOK_URL
    -H 'Content-Type: application/json'
    -d '{
      "data":{
        "client_id":"512cc654f0e342efcdd3fdfde9fd8000",
        "flexible_ride_id":"3fad6e43719a48f3904b5f2d54865b1a",
        "occurred_at":"2026-08-17T08:11:52Z"
      },
      "type": "flexible-ride-cancelled",
      "errors": []
    }'

Failed

A webhook of type flexible-ride-failed is dispatched when a Flexible Ride status is set as failed

The data payload of the webhook message contains the following fields:

FieldTypeDescription
client_idstringYour Cabify client identifier
flexible_ride_idstringThe flexible ride identifier
occurred_atstring (ISO 8601)When the flexible ride was failed
causestringCause of what made the flexible ride fail

Example Request

curl -X POST
    YOUR_WEBHOOK_URL
    -H 'Content-Type: application/json'
    -d '{
      "data":{
        "client_id":"512cc654f0e342efcdd3fdfde9fd8000",
        "flexible_ride_id":"3fad6e43719a48f3904b5f2d54865b1a",
        "occurred_at":"2026-08-17T08:11:52Z",
        "cause": "overbudget"
      },
      "type": "flexible-ride-failed",
      "errors": []
    }'

Did this page help you?