Developer Platform
Build with stopSuite
Extend the platform, integrate with your systems, and automate workflows using our REST API, real-time webhooks, and embeddable onboarding plugin.
Three ways to integrate
Everything you need to connect stopSuite with the rest of your tech stack.
REST API
Programmatic access to stopSuite. Manage customers, locations, routes, stops, services, and tags through 30+ endpoints.
- HMAC-SHA256 authentication
- Granular permission scoping
- Rate limiting & interactive OpenAPI docs
Webhooks
Real-time event notifications pushed to your systems. React instantly to changes across your stopSuite account.
- customer.*, customer_location.*, stop.*
- HMAC-SHA256 signed payloads
- Delivery logging
Onboarding Plugin
Embeddable JavaScript widget that lets new customers sign up directly from your website. One script tag to install.
- Service area check & address autocomplete
- Package/pricing display & signup flow
- Customizable to your brand colors
Simple to use
Clean, predictable JSON responses. Here's what a webhook payload looks like.
{
"event": "stop.completed",
"stop": {
"id": 184502,
"customer_location": 9714,
"order": 7,
"status": "complete",
"notes": "",
"timestamp": "2026-02-13T09:15:23.821709-05:00",
"driver_actions": [],
"driver_images": [],
"flags": [],
"service_records": [
{
"id": 301847,
"service_type": 2,
"service_type_code": "96GAL",
"service_type_string": "96 Gallon Trash Cart",
"quantity": 1,
"weight": "0.00"
}
],
"route": {
"id": 8341,
"date": "2026-02-13",
"schedule": {
"id": 42,
"name": "Thursday_1",
"day": "4",
"frequency": "weekly",
"color": "rgb(76, 175, 80)"
},
"driver": { "user": { ... } },
"vehicle": {
"nickname": "0012 Rear Loader",
"make": "Peterbilt",
"model": "520",
"year": "2021",
"license_plate_number": "TRK-4821",
"vehicle_type": "TRUCK",
"fuel_type": "Diesel",
"gvwr": "33000",
"empty_weight": 18500,
"active": true
}
}
}
}