API Docs

Integration reference for RideVoy operational data flows.

Use this guide to plan authentication, endpoint access, webhook handling, and production rollout for RideVoy integrations into EHR, analytics, billing, or dispatch-adjacent systems.

Contact Integration Team Security Overview

Environment and authentication

Base URL

Production API traffic is served from the same domain under /api. If your deployment includes dedicated integration routing, your implementation contact will provide the environment-specific base URL.

https://www.getridevoy.com/api

Auth model

RideVoy uses bearer token authentication. Tokens should be scoped to least-privilege roles and rotated on a regular schedule aligned with your security policy.

Authorization: Bearer <token>

Core endpoint families

Domain	Purpose	Typical operations
Rides	Create, update, and track ride lifecycle records.	List rides, create ride requests, update status, fetch exceptions.
Riders	Manage rider identities, preferences, and accommodation profiles.	Create rider, update profile, link recurring schedules.
Drivers/Fleet	Manage driver records, assignment state, and execution context.	Driver lists, activation changes, assignment updates.
Reporting	Export operational metrics and fulfillment trends.	Daily summaries, facility-level KPIs, completion exports.

Example API request and response pattern

Request example

curl -X GET "https://www.getridevoy.com/api/rides?status=scheduled&limit=50" \
  -H "Authorization: Bearer <token>" \
  -H "Accept: application/json"

Response conventions

Endpoints return JSON payloads. Errors include a stable code, message, and context fields so retry and escalation logic can be implemented cleanly.

{
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Missing required field: pickupTime",
    "requestId": "req_123"
  }
}

Webhook and reliability guidance

Event coverage

Webhook events typically include ride scheduled, driver assigned, ride started, ride completed, and ride exception transitions.

Retry behavior

Use idempotent handlers and deduplicate by event ID. Treat non-2xx responses as retry candidates and alert on persistent failures.

Operational controls

Instrument request latency, error rates, and replay queues. Tie alert thresholds to mission-critical workflows like discharge and recurring dialysis rides.

Need endpoint-level implementation support?

Share your integration architecture and we can map payload flows, auth scope, and rollout sequencing with your team.

Contact Integration Team Open Help Center