Before you go live
This is the list we will go through with you. Each line is here because getting it wrong is invisible in testing and expensive in production.
Storage and addressing
- [ ] The idempotency key is written to your consult record before you submit, not after our response arrives.
- [ ] A retry of the same consult reuses that key rather than generating a new one.
- [ ] The connection token is stored against your user and the practice, so a vet who works at two sites does not overwrite their own connection.
Mapping
- [ ] Destination fields are mapped on each section's
key, never on its position in the array. - [ ] Response fields you do not recognise are ignored rather than rejected. Within
/v1we only add.
Failure handling
- [ ] The transcript is shown when a note fails with it present. This is the one that decides whether a lost consult is recoverable.
- [ ] A failed note with no error code is treated as unrecoverable, not retried.
- [ ] An incomplete-audio warning reaches the vet before they file.
- [ ] No failure path asks the vet to re-record a consult that is over.
Connection lifecycle
- [ ] A revoked connection clears the stored token and offers to reconnect.
- [ ] A disabled integration stops retrying and raises an alert to you, because reconnecting the vet cannot fix it.
- [ ] Your consultation screen reads the connection on load and hides recording when the practice cannot generate notes.
Operational
- [ ] Polling runs every 3 seconds and gives up after 5 minutes rather than for ever.
- [ ] Rate limits back off and respect
Retry-After. - [ ]
external_refcarries your own consult identifier, so support conversations can find a note quickly. - [ ] Outcomes are reported. Optional, but it is the only measurement either of us has of whether the notes are any good.
Credentials
- [ ] The client secret lives in your backend and has never reached a browser.
- [ ] Every redirect URI you use in production is registered with us.
- [ ] Your sandbox credentials are connected to a test account, not a working clinic.
When you are through this list, tell us and we will enable your integration for production traffic.