Identity
Who the token belongs to and what it may do. The first call any integration makes, and the quickest way to confirm a key is wired correctly.
Developers
One API in. Webhooks out. The same gate.
Everything the agent does on a call is reachable from a client's own software: calls, agents, text messages, leads, bookings and speech, behind one REST API with one token, with results pushed back by webhook as they happen. An OpenAPI spec is served for import into SwaggerHub or Postman.
The REST API
One API, one token, ticked abilities
A token is created in the dashboard with the abilities it needs ticked and nothing else. The same API serves the platform's own tools, so there is no second-class path for outside software.
Calls and agents
Read call records with their summaries, and where switched on their transcripts, and work with the agents on the account. Results arrive by webhook as they happen rather than by polling.
Text messages and replies
Plain texting for the client's own software: reminders, codes, dispatch notices. Replies are posted back to their software, opt-outs are handled by the platform before they get there, and an own number is recommended for two-way. New Zealand and Australian numbers.
Leads and form endpoints
Read and write the leads board. A form endpoint takes a website or ad form post with a one-off field match, so an existing form feeds the pipeline without rebuilding it.
Website booking and calendar
Read availability, create, change and cancel appointments against the same diary the bookings agent writes to, with read-only or booking keys.
Speech
Text in, one of the platform's voices out, with New Zealand place names and the client's own words said properly. For a client's own announcements, prompts and read-outs, in the voice their agent already uses.
Webhooks
Results pushed as they happen
A call ends, a text reply arrives, a lead is created or moves stage, a campaign call finishes: each can fire a webhook to a URL the client controls, carrying the record and its summary. Result webhooks are how an outgoing call started over the API reports back, and how a lead automation hands a new enquiry to the client's own software without a poll.
Call notifications use the same mechanism: plain-English routing per destination decides which calls post to Slack, Microsoft Teams or any webhook, and the platform posts only, reading nothing back. Paperwork filed by phone can be delivered the same way, as a webhook carrying the finished record.
Embeds
Two things that go on a website
Website chat embed
One line of code puts the agent on the site, typing or talking, in the business's own colours. An allowed-domain list decides where it loads, the API key never reaches the browser, and there is no vendor branding in the snippet, the loader or the visible widget. The transcript follows the visitor across pages for an hour. See website chat.
Booking calendar embed
A booking calendar embedded in the business's own form, reading the same live diary the phone agent books into. For a field-services business, “we're already nearby” marks the days it already has work near that address.
Everything else
Zapier, and the connections already built
For software that is not worth a custom build, Zapier connects the platform to the rest of a client's stack. The named integrations, from Fergus and Xero to HubSpot and Cliniko, are built and run by the platform and go straight to that system; none of them go through Zapier, so a connection listed there does not need a developer.
For software not on the list, a connection can be built per vendor API as a custom setup, scoped in the briefing. The connection itself is never promised on a call; a person agrees it first.
Getting access
A token from the dashboard, a spec to import
- Create a token in the client's dashboard, ticking only the abilities the integration needs. A read-only token for reporting, a booking token for a website form.
- Import the OpenAPI spec into SwaggerHub, Postman or a code generator. Every section above is documented in it.
- Register a webhook URL for the events the client wants pushed, and route call notifications in plain English per destination.
- Stay inside the rules. Anything that rings or texts a customer is held to the same window as campaigns, 8am to 10pm on the clock of the person rung, and to lists the business owns. Do-not-call and STOP are honoured by the platform, not by the caller's code.
Calls, transcription and recordings are handled in New Zealand and Australian data centres, and nowhere else, whichever route started them. Recordings and transcripts are off by default and switched on by the client, and the API returns them only when they exist. See security.
Next step
Bring the integration you have in mind
A partner briefing walks through the spec, the webhook events and the embeds against the software your clients actually run. Custom connections are scoped there.