Build on the bay feed

Read work order state, subscribe to webhooks for bay events, and drive your own notification sequences.

Quickstart Webhook catalog Client libraries

Quickstart

Create the client, then dispatch your first work order into Bay 1.

curl POST /v1/jobs/dispatch

curl -X POST https://api.your-product.example/v1/jobs/dispatch \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"bay_id":"bay_01","vehicle":"2023 Toyota RAV4"}'

Authentication

Every request carries a bearer token. Production keys start with live_ and sandbox keys with test_. Both are generated in the console under settings.

header

Authorization: Bearer live_your_api_secret_key

Webhooks

The board posts a payload when schedule state changes on the floor.

job.slipping_alert high priority

Fires the moment a job drifts past the tolerance window you configured. Ten minutes by default.

bay.status_changed state

Fires when a technician moves a bay between occupied, waiting on parts, quality check and idle.

customer.sms_delivered gateway log

Fires when the carrier confirms a status update or delay notice reached the customer.

Client SDKs

Typed clients for the endpoints above.

node / typescript

npm install your-sdk

python 3.9+

pip install your-sdk

Ask for a trial Ask us about your setup