Developer API

Connect your TMS, HRIS, or custom tooling

Sync driver rosters automatically, pull feedback and sentiment analytics into your own dashboards, and get real-time alerts in your systems when a high-value driver needs attention. API keys are free with every DriverOpenDoor account — get yours in Settings → Developer API.

Developer API

Connect your TMS, HRIS, or custom tooling directly to DriverOpenDoor via the REST API. All endpoints use API key authentication and return JSON.

Roster sync: Use PUT /workers/bulk to push up to 1,000 drivers at once. The request returns immediately with a job_id — poll GET /workers/bulk/:jobId for results.

Base URLhttps://app.driveropendoor.com/api/v1
Download PDF

Authentication

All API requests require your key in the x-api-key header. Get your key from Settings → Developer API in your dashboard.

Required header
x-api-key: dod_sk_your_key_here

Scopes

Each API key is limited to the scopes you select at creation time.

workers:readList, get, and poll bulk upsert job status
workers:writeCreate, update, delete drivers; submit bulk upsert jobs
feedback:readRead feedback data (no driver identity exposed)
analytics:readWeekly sentiment trends and aggregates
dispatchers:readList dispatcher roster
dispatchers:writeCreate dispatchers
webhooks:readList registered webhook endpoints
webhooks:writeRegister and delete webhook endpoints

Error Responses

All errors follow a consistent format with a machine-readable code and human-readable message.

Error shape
{
  "error": {
    "code": "validation_error",
    "message": "Phone number must be E.164."
  }
}
200Success
201Resource created
202Job accepted (async — poll for results)
400Validation error
401Invalid or missing API key
403Key missing required scope
404Resource not found
429Rate limit exceeded
500Server error

Rate Limits

Default limit is 1,000 requests per hour per API key. When exceeded, you receive a 429 response — wait before retrying. Each company can hold up to 10 active API keys.

Bulk upsert counts as 1 request regardless of how many rows you send. Polling the job status endpoint also counts as 1 request per poll. For a nightly sync of 5,000 drivers (5 batches + ~5 polls), that's roughly 10 requests total.

Webhook Events

Subscribe to any of these events when registering a webhook. Every event uses the same envelope: id, event, created_at, and an event-specific data object.

vip_alert.created

A high-value driver submitted negative feedback. data: feedback_id, severity, worker_value_rating, sentiment, urgency_score, keywords

critical_alert.created

Feedback met critical-alert conditions. data: feedback_id, alert_type, severity, sentiment, urgency_score, keywords

tenure_alert.created

A new-hire or tenured driver triggered an alert. data: feedback_id, band (new_hire | tenured), severity, tenure_days, sentiment, urgency_score, keywords

silent_decline_alert.created

Samsara telematics detected a multi-week decline in driving activity. data: week_start, severity, miles_trend_pct, driving_days_trend_pct, idle_trend_pct, compounding_signals, has_legit_explanation

feedback.analyzed

New feedback was processed by AI (sentiment + keywords ready). data: feedback_id, sentiment, sentiment_score, urgency_score, keywords, flagged, critical_alert, critical_alert_type

worker.created

A new driver was added to your fleet. data: worker_id, name, phone, fleet_driver_id, source

worker.updated

A driver's status or info changed. data: worker_id, changes (list of updated fields)

Verifying Webhook Signatures

Every webhook POST includes an X-DOD-Signature header: the HMAC-SHA256 hex digest of the raw request body, computed with the signing_secret shown once at webhook creation. Verify it against the raw body (before JSON parsing) to confirm the payload came from DriverOpenDoor.

Node.js
import { createHmac, timingSafeEqual } from 'crypto'

function verifyDODWebhook(signingSecret: string, signature: string, rawBody: string): boolean {
  const expected = createHmac('sha256', signingSecret).update(rawBody).digest('hex')
  const a = Buffer.from(expected, 'hex')
  const b = Buffer.from(signature, 'hex')
  return a.length === b.length && timingSafeEqual(a, b)
}

Workers

GET/api/v1/workers

List workers

Returns a paginated list of all drivers in your fleet. Filter by status to find active, inactive, or departed drivers.

Query Parameters

pageinteger· default: “1”

Page number

per_pageinteger· default: “50”

Records per page (max 100)

statusstring

Filter by status: active, inactive, opted_out, undeliverable, left_company

Responses

200Successful response
401Authentication failure
GET/api/v1/workers
curl "https://app.driveropendoor.com/api/v1/workers?status=active&per_page=100" \
  --header "x-api-key: dod_sk_your_key_here"
{
  "data": [
    {
      "id": "uuid",
      "name": "Marcus Johnson",
      "phone": "+16462508211",
      "phone_formatted": "+1 (646) 250-8211",
      "email": null,
      "status": "active",
      "hire_date": "2024-03-15",
      "value_rating": 9,
      "fleet_driver_id": "DRV-1042",
      "tags": [
        "CDL-A",
        "OTR"
      ],
      "created_at": "2024-03-15T10:00:00Z"
    }
  ],
  "meta": {
    "page": 1,
    "per_page": 100,
    "total": 847,
    "has_more": true
  }
}
Successful response
PUT/api/v1/workers/bulk

Bulk upsert workers

The primary endpoint for TMS roster syncs. Submits up to 1,000 workers and returns a job_id immediately (202) — the actual upsert runs in the background. Poll the job status endpoint until completed. Existing workers are matched by fleet_driver_id first, then phone number as a fallback. Requires workers:write to submit and workers:read to poll.

Body Parameters

workersarrayrequired

Array of worker objects (max 1,000)

workers[].namestringrequired

Full name, max 200 chars

workers[].phonestringrequired

E.164 (+16462508211) or 10-digit US (6462508211)

workers[].fleet_driver_idstring

Your internal driver ID — strongly recommended for reliable matching

workers[].emailstring

Driver email address

workers[].hire_datestring

YYYY-MM-DD format

workers[].statusstring

active (default), inactive, opted_out, undeliverable, or left_company

workers[].tagsarray

Array of strings, max 20 tags

Responses

202Job accepted
400Validation error (all rows failed)
PUT/api/v1/workers/bulk
# Step 1 — submit the job
JOB=$(curl -s "https://app.driveropendoor.com/api/v1/workers/bulk" \
  --request PUT \
  --header "x-api-key: dod_sk_your_key_here" \
  --header "Content-Type: application/json" \
  --data '{"workers":[{"name":"Marcus Johnson","phone":"6462508211","fleet_driver_id":"DRV-1042","status":"active"}]}')

JOB_ID=$(echo $JOB | jq -r '.data.job_id')

# Step 2 — poll until completed
curl "https://app.driveropendoor.com/api/v1/workers/bulk/$JOB_ID" \
  --header "x-api-key: dod_sk_your_key_here"
{
  "data": {
    "job_id": "uuid",
    "status": "pending",
    "total": 215
  }
}
Job accepted
GET/api/v1/workers/bulk/:jobId

Get bulk upsert job status

Returns the current status of a bulk upsert job. Poll every 1–2 seconds until status is completed or failed. Once completed, the response includes a per-row results array and a summary count of created, updated, and failed rows. Requires workers:read scope.

Responses

200Job completed
404Job not found
GET/api/v1/workers/bulk/:jobId
curl "https://app.driveropendoor.com/api/v1/workers/bulk/job-uuid-here" \
  --header "x-api-key: dod_sk_your_key_here"
{
  "data": {
    "job_id": "uuid",
    "status": "completed",
    "total": 215,
    "summary": {
      "created": 12,
      "updated": 203,
      "failed": 0,
      "total": 215
    },
    "results": [
      {
        "index": 0,
        "action": "updated",
        "id": "uuid",
        "fleet_driver_id": "DRV-1042",
        "phone": "+16462508211"
      },
      {
        "index": 1,
        "action": "created",
        "id": "uuid",
        "phone": "+13125550100"
      }
    ],
    "created_at": "2026-04-20T14:22:00Z",
    "completed_at": "2026-04-20T14:22:03Z"
  }
}
Job completed
GET/api/v1/workers/:id

Get a worker

Fetch a single worker record. The :id path parameter can be the DOD worker UUID or your fleet_driver_id.

Responses

200Successful response
404Not found
GET/api/v1/workers/:id
curl "https://app.driveropendoor.com/api/v1/workers/DRV-1042" \
  --header "x-api-key: dod_sk_your_key_here"
{
  "data": {
    "id": "uuid",
    "name": "Marcus Johnson",
    "phone": "+16462508211",
    "phone_formatted": "+1 (646) 250-8211",
    "email": null,
    "status": "active",
    "hire_date": "2024-03-15",
    "value_rating": 9,
    "fleet_driver_id": "DRV-1042",
    "tags": [
      "CDL-A",
      "OTR"
    ],
    "created_at": "2024-03-15T10:00:00Z"
  }
}
Successful response
PATCH/api/v1/workers/:id

Update a worker

Update specific fields on a worker record. Send only the fields you want to change.

Body Parameters

namestring

Full name

phonestring

E.164 or 10-digit US phone

emailstring

Driver email

statusstring

active, inactive, opted_out, undeliverable, or left_company

tagsarray

Replaces the existing tags array

hire_datestring

YYYY-MM-DD

fleet_driver_idstring

Your internal driver ID (max 120 chars)

preferred_languagestring

Driver survey language: en, es, pa, or ru

Responses

200Successful response
400Validation error
PATCH/api/v1/workers/:id
curl "https://app.driveropendoor.com/api/v1/workers/DRV-1042" \
  --request PATCH \
  --header "x-api-key: dod_sk_your_key_here" \
  --header "Content-Type: application/json" \
  --data '{"status": "inactive", "phone": "6462508212"}'
{
  "data": {
    "id": "uuid",
    "status": "inactive",
    "phone": "+16462508212"
  }
}
Successful response
POST/api/v1/workers

Create a worker

Add a single driver to your fleet. New drivers are always created with status "active" — use the update endpoint to change it afterward.

Body Parameters

namestringrequired

Full name, max 200 chars

phonestringrequired

E.164 (+16462508211) or 10-digit US

fleet_driver_idstring

Your internal driver ID

emailstring

Driver email

hire_datestring

YYYY-MM-DD

tagsarray

Array of strings, max 20 tags

Responses

201Worker created
400Validation error
POST/api/v1/workers
curl "https://app.driveropendoor.com/api/v1/workers" \
  --request POST \
  --header "x-api-key: dod_sk_your_key_here" \
  --header "Content-Type: application/json" \
  --data '{
    "name": "Marcus Johnson",
    "phone": "6462508211",
    "fleet_driver_id": "DRV-1042",
    "hire_date": "2024-03-15",
    "tags": ["CDL-A", "OTR"]
  }'
{
  "data": {
    "id": "uuid",
    "name": "Marcus Johnson",
    "phone": "+16462508211",
    "fleet_driver_id": "DRV-1042",
    "status": "active",
    "created_at": "2024-03-15T10:00:00Z"
  }
}
Worker created
DELETE/api/v1/workers/:id

Deactivate a worker

Sets the worker's status to left_company. All historical feedback and records are preserved.

Responses

200Successful response
404Not found
DELETE/api/v1/workers/:id
curl "https://app.driveropendoor.com/api/v1/workers/DRV-1042" \
  --request DELETE \
  --header "x-api-key: dod_sk_your_key_here"
{
  "data": {
    "id": "uuid",
    "status": "left_company"
  }
}
Successful response

Feedback

GET/api/v1/feedback

List feedback

Returns AI-analyzed feedback. Driver identity is never exposed — no worker_id in responses. Driver, Driver Manager, and Dispatcher names only appear if the driver explicitly chose to reveal; otherwise driver_manager_name and dispatcher_name are null.

Query Parameters

pageinteger· default: “1”

Page number

per_pageinteger· default: “50”

Records per page (max 100)

sentimentstring

Filter by sentiment: positive, neutral, negative

sincestring

Start of date range, ISO format (YYYY-MM-DD)

untilstring

End of date range, ISO format (YYYY-MM-DD)

week_startstring

Exact week (must be a Monday)

vip_onlyboolean

Only feedback that triggered a VIP alert

Responses

200Successful response
401Authentication failure
GET/api/v1/feedback
curl "https://app.driveropendoor.com/api/v1/feedback?sentiment=negative&since=2026-01-01" \
  --header "x-api-key: dod_sk_your_key_here"
{
  "data": [
    {
      "id": "uuid",
      "week_start": "2026-04-14",
      "rating": 2,
      "comment": "Equipment issues and dispatch communication was terrible this week.",
      "sentiment": "negative",
      "sentiment_score": -0.82,
      "urgency_score": 4,
      "keywords": [
        "equipment",
        "dispatch",
        "communication"
      ],
      "llm_summary": "Driver reported severe equipment issues and communication breakdown with dispatch.",
      "driver_manager_name": null,
      "dispatcher_name": null,
      "vip_alert": true,
      "flagged": true,
      "created_at": "2026-04-16T14:22:00Z"
    }
  ],
  "meta": {
    "page": 1,
    "per_page": 50,
    "total": 312,
    "has_more": true
  }
}
Successful response

Analytics

GET/api/v1/analytics/sentiment

Sentiment trends

Weekly sentiment breakdown for the last N weeks. Use this to pull trend data into your own BI tools or dashboards.

Query Parameters

weeksinteger· default: “12”

Number of weeks to return (max 52)

Responses

200Successful response
401Authentication failure
GET/api/v1/analytics/sentiment
curl "https://app.driveropendoor.com/api/v1/analytics/sentiment?weeks=12" \
  --header "x-api-key: dod_sk_your_key_here"
{
  "data": [
    {
      "week_start": "2026-04-14",
      "total_feedback": 47,
      "avg_rating": 3.8,
      "positive_pct": 55.3,
      "neutral_pct": 29.8,
      "negative_pct": 14.9
    }
  ]
}
Successful response

Dispatchers

GET/api/v1/dispatchers

List dispatchers

Returns all dispatchers in your fleet roster.

Responses

200Successful response
401Authentication failure
GET/api/v1/dispatchers
curl "https://app.driveropendoor.com/api/v1/dispatchers" \
  --header "x-api-key: dod_sk_your_key_here"
{
  "data": [
    {
      "id": "uuid",
      "name": "Carlos Rivera",
      "email": "carlos@fleet.com",
      "phone": "+13125551234",
      "created_at": "2024-01-10T09:00:00Z"
    }
  ]
}
Successful response
POST/api/v1/dispatchers

Create a dispatcher

Add a new dispatcher to your fleet roster.

Body Parameters

namestringrequired

Dispatcher full name

emailstring

Dispatcher email address

phonestring

E.164 or 10-digit US phone

Responses

201Dispatcher created
400Validation error
POST/api/v1/dispatchers
curl "https://app.driveropendoor.com/api/v1/dispatchers" \
  --request POST \
  --header "x-api-key: dod_sk_your_key_here" \
  --header "Content-Type: application/json" \
  --data '{"name": "Carlos Rivera", "email": "carlos@fleet.com", "phone": "3125551234"}'
{
  "data": {
    "id": "uuid",
    "name": "Carlos Rivera",
    "email": "carlos@fleet.com",
    "phone": "+13125551234",
    "created_at": "2024-01-10T09:00:00Z"
  }
}
Dispatcher created

Webhooks

POST/api/v1/webhooks

Register a webhook

Register an HTTP endpoint to receive real-time events. The signing_secret is shown once — store it securely to verify payloads.

Body Parameters

urlstringrequired

HTTPS endpoint to receive events

eventsarrayrequired

List of events to subscribe to

Responses

201Webhook registered
400Validation error
POST/api/v1/webhooks
curl "https://app.driveropendoor.com/api/v1/webhooks" \
  --request POST \
  --header "x-api-key: dod_sk_your_key_here" \
  --header "Content-Type: application/json" \
  --data '{
    "url": "https://your-tms.com/webhooks/dod",
    "events": ["vip_alert.created", "feedback.analyzed"]
  }'
{
  "data": {
    "id": "uuid",
    "url": "https://your-tms.com/webhooks/dod",
    "events": [
      "vip_alert.created",
      "feedback.analyzed"
    ],
    "signing_secret": "a1b2c3d4e5f6...",
    "active": true
  },
  "message": "Store the signing_secret securely — it will not be shown again."
}
Webhook registered
GET/api/v1/webhooks

List webhooks

Returns all registered webhook endpoints for your account.

Responses

200Successful response
401Authentication failure
GET/api/v1/webhooks
curl "https://app.driveropendoor.com/api/v1/webhooks" \
  --header "x-api-key: dod_sk_your_key_here"
{
  "data": [
    {
      "id": "uuid",
      "url": "https://your-tms.com/webhooks/dod",
      "events": [
        "vip_alert.created"
      ],
      "active": true,
      "created_at": "2026-01-10T09:00:00Z"
    }
  ]
}
Successful response
DELETE/api/v1/webhooks/:id

Delete a webhook

Remove a registered webhook endpoint. Events will stop being delivered immediately.

Responses

200Successful response
404Not found
DELETE/api/v1/webhooks/:id
curl "https://app.driveropendoor.com/api/v1/webhooks/uuid" \
  --request DELETE \
  --header "x-api-key: dod_sk_your_key_here"
{
  "message": "Webhook deregistered."
}
Successful response