Workflow Examples

List And Triage Service Requests

GET /api/v1/service-requests?limit=20&offset=0
Authorization: Bearer bzy_live_...

Fetch a page of service requests, inspect status and lead source fields, then update the service request status when the downstream workflow has acted.

PATCH /api/v1/service-requests/{id}/status
Authorization: Bearer bzy_live_...
Content-Type: application/json

Create A Service API Key

POST /api/v1/integrations/api-keys
Authorization: Bearer <user-jwt>
Content-Type: application/json

Use a user JWT for this workflow. API keys cannot manage other API keys.

Create A Webhook Endpoint

POST /api/v1/integrations/webhooks
Authorization: Bearer <user-jwt>
Content-Type: application/json

Use a user JWT for this workflow. Store the returned signing secret immediately; it is shown only once.

Update Contact Attribution

GET /api/v1/contacts?limit=20&offset=0
Authorization: Bearer bzy_live_...

Find the contact, then update the contact lead source when an integration improves attribution.

PATCH /api/v1/contacts/{id}/lead-source
Authorization: Bearer bzy_live_...
Content-Type: application/json