API & webhooks

Send bookings into your dispatch workflow

Connect your website, partner portal or internal software to our chauffeur booking API. Your developer can quote journeys, create bookings and receive operational updates while your dispatchers work with those rides in TransferCRM.

Start free trialOpen live demo

Included from the Pro plan

  • Public OpenAPI specification
  • Read, write and admin scopes
  • Signed webhook deliveries

From your system to dispatch

Quote the journey, then create the booking

Use API v2 to put the passenger, route and pickup time into the same bookings your office manages. Your integration chooses when to request a price and when to submit the ride.

  • Request a journey price

    Send the journey to POST /api/v2/quote for pricing from your rate book. A read key can request quotes without creating or changing bookings.

  • Create the ride

    POST /api/v2/book accepts pickup details, passenger information, vehicle class and flight number. Supply your agreed price or let our rate book price the journey.

  • Keep your booking reference

    Send an external_reference with the booking. Repeating that reference returns the existing booking, giving your system a way to retry without creating another ride.

  • Include the return journey

    Add a return_trip with its pickup date to create linked outbound and return rides together. Each leg can carry its own external reference.

  • Read and update bookings

    List bookings, retrieve one ride, update its details or request cancellation through documented endpoints. Write access includes changes that can affect prices and refunds.

Access you can explain

Give each integration the access it needs

Create a named key on the Developer screen and choose its access level. Our API enforces that choice on each endpoint; the public reference states the scope each operation requires.

  • Inspect the public contract

    Open /api/v2/openapi.json without a key to inspect request fields, responses and required scopes. The Developer screen builds its endpoint reference from that same specification.

  • Start with read access

    A read key can check availability, request quotes and retrieve bookings, clients, drivers, vehicles, partners and invoices through the documented endpoints.

  • Grant write access deliberately

    Write includes read access and permits booking creation, edits and cancellation, plus client, driver and partner changes. Choose it when your integration needs those operations.

  • Reserve admin for webhooks

    Admin includes write and read access. Every webhook management endpoint requires it, including subscription lists, delivery logs, test deliveries and signing secret rotation.

  • See when keys are used

    The Developer screen shows each key's access level, state and last use. Save a newly created key when it appears; later lists show only its prefix.

Updates back to your system

Subscribe to events and inspect their deliveries

Give us a public receiver URL and select the events your software needs. Your developer can verify incoming messages and use delivery history to investigate a receiver that stops accepting updates.

  • Follow operational changes

    Subscribe to booking creation, driver assignment, travel status, flight delay, completion or cancellation events. The event catalogue also covers partner handovers, clients, drivers and invoices.

  • Verify each message

    Use the webhook signing secret to verify the HMAC-SHA256 signature against the timestamp and raw body. Stable event IDs let your receiver recognise repeated deliveries.

  • Recover from temporary failures

    Network failures and retryable HTTP responses trigger scheduled retries. Redirects and permanent client errors stop delivery; repeatedly failing subscriptions are disabled and the owner is alerted.

  • Inspect the receiver's response

    Check delivery history for the event, HTTP status, success result, duration and response excerpt. Send a signed test delivery to check your receiver during setup.

  • Size the connection

    Pro includes 1,000 API requests per day and three webhook endpoints. Business includes 10,000 daily requests and unlimited webhook endpoints for larger integration workloads.

Related features

Integrations

Frequently asked questions

What does a developer need to connect a booking system?

Start with our public OpenAPI document at /api/v2/openapi.json, then create a scoped key in the Developer screen. Send the key using Authorization: Bearer or X-API-Key. Your developer builds the requests and maps your system's fields to the documented contract. Creating a key alone does not connect another application.

What happens when a journey has no price?

When you omit price, POST /api/v2/book uses your rate book. If it cannot price the journey, the API returns a not_priced error and creates no booking. You can instead supply an agreed price. For a round trip, a return leg that cannot be priced prevents creation of the whole booking.

Which plan includes the API and webhooks?

Both API access and webhooks start with Pro: 1,000 requests per workspace per day and three webhook endpoints. Business raises those allowances to 10,000 daily requests and unlimited endpoints. A separate limit allows 60 requests per minute per key. Daily quotas reset at midnight UTC; quota responses include remaining allowance and reset information.

How do webhook retries work?

For temporary failures, we retry after delays of one minute, five minutes, thirty minutes, two hours and twelve hours. Most HTTP 4xx responses are permanent; 408 and 429 can be retried. Redirects are not followed. After ten consecutive deliveries fail permanently or exhaust their retries, the subscription is disabled and an email alert is sent to the owner.

Can I test a webhook before relying on it?

Yes. Send a signed test delivery and inspect the HTTP status, duration and response in the result or delivery history. Test payloads carry a test flag so your receiver can avoid normal side effects. They can contain a recent record from your workspace; use a receiver you control and verify its handling of repeated event IDs.

Connect your booking workflow

Explore the API contract, choose the right access level and bring your bookings into TransferCRM.

Start your free trialCompare plans in detail

No credit card. 14 days free. Cancel anytime.