Developers
PreviewStart RowCall calls from your systems, receive answers by webhook, and let flows act through your own APIs.
Your systems can do through the API what your team does in the RowCall app: start calls, read answers and keep contacts up to date. A store or a commerce platform sends an event, RowCall places the call, and the results come back as signed webhooks.
How it fits together
RowCall's API is two-way:
- You → RowCall. Start, read and cancel runs with the REST API (
/v1). Add contacts with their consent. Define the actions your flows may use. - RowCall → you, during the call. When the shopper needs something only your systems can do, such as changing an address, RowCall takes the action: a signed request to your action URL, or your own HTTP request. The shopper stays on the line for the reply.
- RowCall → you, after things happen. Signed webhook events: run queued, answered, completed, action done, handoff, opt-out.
RowCall owns everything under the call: phone numbers, voices, speech recognition, recordings and the flow. You own your data and your business rules. The AI never changes anything directly; it asks, and your systems decide.
The words you'll meet
- Flow. The call script: its inputs, questions, outcomes and the actions it may use. Built in the app or by API.
- Run. One flow for one shopper. A run places up to its
maxAttemptscalls within calling hours, then ends with answers and an outcome. - Call. One attempt of a run, with its transcript and recording.
- Action. Something your systems do for the shopper during a call, such as confirming an order.
- Event. A signed notice RowCall posts to your webhook URL when something happens.
The basics
- Base URL.
https://app.rowcall.ai/v1. - Format. JSON in and out, field names in camelCase, times in ISO 8601. Every response has
ok; a failure also haserroranderrorCode. See Errors. - Credentials. An API key for your own org, or OAuth tokens when your app acts for many merchants. See Authentication and keys.
- The spec. The API reference is built from the OpenAPI document, which you can download from
/docs/reference/openapi.jsonor fetch fromGET /v1/openapi.json(no key needed) for tools and code generators.
Before you start
- An org role that can manage Developers (owners and admins). See Roles and permissions.
- A test API key from Developers → API keys.
- A published flow to start runs with.
- An HTTPS endpoint for webhooks, if you want results pushed to you.
Apps that many stores connect
A platform whose merchants each have their own RowCall org, such as Glood, connects over OAuth instead of API keys. Each merchant clicks Connect once, your app gets tokens that act for their org, and every merchant's events and action requests come to your one URL. See Build an integration.
In this section
Authentication and keys
Test and live keys, scopes, rolling and revoking.
Build an integration
Connect many merchants' orgs over OAuth.
Start a run
Your first call from code, and what happens next.
Flows API
Find a flow and the inputs it needs.
Calls and results
Read status, answers, transcripts and recordings.
Webhooks
Events, signatures, retries and duplicates.
Actions
Let a flow act through your systems.
Test mode
Build without placing a phone call.
Handling errors
What to retry, what to fix, and how to branch.
The developer platform is Preview: it opens to invited partners first, and new fields may be added.
Next stepAuthentication and keysGet a key and make your first authenticated request.