ConceptFor engineers
Guides
How to work with the Awell Orchestration API, covering authentication, what the API returns, and specific integration jobs.
The guides cover how to work with the Orchestration API: getting a key accepted, reading what comes back, and carrying out specific integration jobs. Operation-by-operation detail lives in Reference.
Read these first
Read them in this order on a first integration.
- Getting started. The endpoint, the auth header, and a working query.
- Authentication. How to obtain an API key and send it with every request.
- Environments. Sandbox, production, and the regional endpoints.
- Domain model. The objects the API works with, and the lifecycle of a typical integration.
The behavior that applies to every call
| Page | Covers |
|---|---|
| Pagination | Paging and sorting list results. |
| Errors | The code / success envelope, plus GraphQL errors. |
| Rate limits | The limits, and how to handle throttling. |
| Mutations | An orientation to the write operations. |
| E.164 phone numbers | The phone number format every write has to use. |
| Versions and releases | Why care flow queries need the right release_id. |
Guides for specific integration jobs
| Page | Covers |
|---|---|
| Start a care flow | Prerequisites, the start mutations, and hosted-pages sessions. |
| Query activities | The activity lookups and the server-side filters. |
| Work with forms | Rendering, conditional logic, and submitting answers. |
| Manage patients | Creating and updating patients, and the identifier behavior to watch. |
| Webhooks | How care flows call other systems, and how to inspect and retry. |
| Webhook payloads | The payload shape for each event. |
Next: Getting started — confirm a key works before building anything on it.