Reference
Instant integrator API
What an integrator's servers call to run their customers in Instant: the customers, their members and the members' tokens, the webhook Instant posts to, and the return URL. Every request carries the integrator's credential as Authorization: Bearer <credential>. Ids are UUIDs, matched in any case and answered in lower case; a path id that is not a UUID is the same 404 as an unknown one, and so is another integrator's object. Bodies are strict: a field a route does not take is 400. A route that takes a query is strict about it too; a route that takes none ignores one. Every answer but the docs' is Cache-Control: no-store; the docs answer private, no-cache with an ETag. A field may be added to an answer at any time, so ignore fields you do not know.
- Base URL
https://app.booksbyinstant.com- Version
- 1
- Spec
- openapi.json, OpenAPI 3.1.0
This page as markdown; every page has one, at its address plus index.md.
Start here
Instant integrator API guide: the conventions every route follows, retries, webhook verification and how each object lives.
Authentication
Bearer token live_<100 hex>
Authorization: Bearer <secret>. A 401 answers WWW-Authenticate: Bearer realm="instant-integrator-api".
Integrator
Which integrator a credential belongs to.
Customers
The integrator's customers: each is a company in Instant, created with its first member, who owns it.
Members
The people of a customer, each with a role and entity access.
Member tokens
The secrets a member's requests to the customer API carry. The integrator issues them.
Webhook
Where Instant posts what happens in the integrator's customers and when the docs change, and the deliveries it made.
Return URL
Where a member's browser comes back after connecting a mailbox, a calendar or a bank.
Docs
This API's reference and guide, and the customer API's, as Instant serves them now.
Webhooks
approval.dueA member's turn to approvebrowser.takeover_neededReserved: not sent yetconnection.expiredA bank consent ran outconnection.syncedA bank backfill or asked read endedcustomer.pausedA customer was pausedcustomer.resumedA customer was resumeddocs.updatedThe docs changedlink.finishedA bank link endedping.raisedA notice to a memberreply.readyA chat reply is readyrun.finishedBackground work finishedtask.input_neededA task needs its owner
For agents and tools
- llms.txt: an index of every page's markdown
- llms-full.txt: the guide, every operation and the webhooks in one file
- openapi.json: the OpenAPI document
- search-index.json: what the search box searches
Versions
The SHA-256 of each file these pages are built from:
- openapi.json
2254e14395856652b73a0371ff5256341991186a93ca59ff8a6f9e26f5318b09- guide/index.md
77ab80d3a775f01d0a8f7712734b5cdd2ce13549408f00464e886c6ab5a9961d