Breezeway

The API adapter is implemented. Validate your own account and authorized actions before routing production calls.

Before you start

Connect the account belonging to this business and workspace. Vendor subscriptions, API limits and role permissions still apply.

API: Breezeway Public Inventory API v1

Authentication: Authorization: JWT access_token

Get access and connect

1. Ask Breezeway for a partner API client and inventory/task access.
2. Exchange client_id and client_secret at the documented /public/auth/v1/ authentication endpoint.
3. Save the resulting access token in Verbatik and test by reading properties.
4. Choose a property home_id and create housekeeping, maintenance, inspection or safety tasks. Assignee IDs must belong to the Breezeway account.
5. Access tokens last 24 hours; reconnect with a current token. Verbatik does not automatically refresh this connection.

Account requirements

• Breezeway partner API credentials
• Account property and assignee IDs

Permissions

• Read property inventory
• Create tasks and assign account users

Grant the subset needed for the actions you enable. API scopes do not override the connected user’s record permissions or vendor validation rules.

Connection fields

• accessToken — API key or authorized access token (required). Secret fields are saved as workspace credentials.

Available actions

• test_connection — Read. Read properties
• create_task — Write. Create a property operations task for cleaning, maintenance, inspection or safety.

Verify before going live

Run Test connection and one read action against a known permitted record. Then test each intended write in an authorized sandbox. Check the provider’s own record and the Verbatik receipt. Publish the agent after assigning its tools. If a write has an unknown outcome, reconcile it with the vendor before trying again.

Vendor documentation

• Setup and API documentation
• Additional provider reference