Integrations & API
This section configures the API access and connectors that live inside Settings: an API access token for calling Flowcall programmatically, a notification webhook for live-chat messages, and telephony integrations for outbound and inbound voice calls. Use it to wire Flowcall into your own systems and to connect your dialer provider.
Settings changes, including the notification webhook URL and enable toggle, are staged. Click Save changes in the bottom bar to apply them, or Discard to revert. Token generation and regeneration have their own actions.
This is the in-settings connector and API page. For the broader library of channels, e-commerce, and API connectors, see Integrations.
API access token
A bearer token for secure API access to your account's resources.
- If no token exists, click Generate Token to create one.
- Once a token exists it is shown in a read-only field. Use the copy button to copy it, or Regenerate to issue a new one — regenerating asks for confirmation and invalidates the current token, so any integration using the old token must be updated.
Keep this token secret: anyone holding it can access your account through the API.
Notification webhook
Sends an HTTP callback for messages sent to a customer in live chat, from a human agent or the AI. Use it to connect Flowcall to your backend's notification service, including when a customer's app WebView is closed or suspended.
Select the correct brand account, then open Settings → Integrations & API → Integrations (/settings/integrations) and find Notification Webhook:
- Enable notifications — toggle delivery on or off.
- Webhook URL — enter your backend's public HTTPS endpoint and save the settings. HTTP, localhost, and the private addresses blocked by URL validation are rejected. This is your endpoint; it is not a Flowcall URL.
The settings offer a URL and enabled flag. They do not configure an authorization header, signing secret, or delivery filters.
Request and payload
Flowcall makes a POST to the registered URL with Content-Type: application/json. The following is synthetic example data:
{
"shopifyCustomerId": "gid://shopify/Customer/1234567890",
"customerName": "Example Customer",
"customerEmail": "customer@example.com",
"customerPhone": "+12025550123",
"message": "Your support request has an update.",
"timestamp": "2026-10-06T06:30:00.000Z"
}
| Field | Meaning |
|---|---|
shopifyCustomerId | Shopify customer ID, when available. |
customerName | Customer name, when available. |
customerEmail | Customer email, when available. |
customerPhone | Customer phone, when available. |
message | Message text, truncated to the first 500 JavaScript string characters. Can be absent for a message without text. |
timestamp | ISO 8601 UTC time when the webhook payload is created. |
All fields except timestamp are optional and unavailable values are omitted from the JSON. The payload has no message ID, account ID, attachment body, read status, device token, or authenticated-user assertion. If multiple brand accounts send to the same backend, distinguish them through separately registered endpoint paths. Do not assume every customer has a Shopify ID, phone, or email.
Delivery behavior and app notifications
The human-agent send path, AI reply delivery, and live-chat instruction messages call this webhook. AI reply delivery can include intermediate replies; the webhook payload does not include isIntermediate, so it cannot use the SDK's interim-message flag to filter them. AI and instruction delivery exclude tester conversations. Customer-sent messages do not trigger this outbound notification webhook.
Delivery is fire-and-forget with a 10-second request timeout. Non-2xx responses, timeouts, and network errors are logged. The helper has no retry queue, automatic redelivery, replay API, or guaranteed ordering/delivery. Its failures do not fail the chat send. Return a 2xx response promptly and queue your own processing if needed.
Requests contain no built-in authorization header or HMAC signature. A payload's phone or email does not prove ownership or authenticate the caller. Agree endpoint protection with Flowcall before using notifications for sensitive actions; never embed your secret API access token in the widget.
Your backend maps the available customer identifier to the correct app user and registered device token, then sends the notification through your own push service. Flowcall does not itself register or send native app push notifications through this webhook. It also does not suppress the webhook based on whether the customer's chat is open, read, or foregrounded; implement notification preferences and duplicate-alert handling in your app/backend.
For active app-owned WebViews, the SDK also offers onMessageReceived. It receives a chat message object with messageId, not this customer identity payload. The hosted URL/iframe does not forward that callback to its parent.
Telephony integrations
Connect a dialer or click-to-call provider. Each provider has an enable toggle plus provider-specific fields, and each surfaces a callback/webhook URL you must register on the provider's side. These callback URLs point at api.flowcall.co and, where noted, include your account ID.
Exotel
For voice calls through Exotel.
- Enable Exotel Outgoing Calls — let agents place outbound calls through Exotel.
- Exotel Outgoing Call Phone Number — the number outbound calls are placed from (e.g.
+1234567890). - Exotel Incoming Call Numbers — a tag list of numbers that receive inbound calls through Exotel.
- Exotel Incoming Call SIDs — a tag list of Call SIDs used to track Exotel calls.
Setup (from the in-app help): register the connect webhook https://api.flowcall.co/webhooks/exotel/programmable-connect in your Exotel dashboard and create a Connect applet per Exotel's Connect-applet guide.
Ozonetel
For click-to-call through Ozonetel CloudAgent.
- Enable Ozonetel — let agents place outbound calls through Ozonetel.
- API Key and Username — your Ozonetel CloudAgent credentials. Shown only until the integration is connected; once connected they're masked and the card shows "Connected as ..." with a Delete button to disconnect.
- Campaign Name — the Ozonetel campaign under which manual/outgoing calls are placed.
- Save stores the credentials and campaign; once connected, saving again just updates the campaign name.
Setup: configure the callback URL https://api.flowcall.co/webhooks/ozonetel/call-callback/<accountId> in the Ozonetel admin portal, and set each agent's ozonetel_agent_id custom field to map Flowcall agents to their Ozonetel agent IDs.
Ameyo
For the Ameyo toolbar, covering inbound and outbound voice.
- Enable Ameyo — turn on the Ameyo dialer toolbar for agents.
- Ameyo Base URL — your Ameyo application server URL including port (e.g.
https://your-ameyo-server.com:7443). Saved when you click away from the field. - Toolbar Script Version — the version of the Ameyo integration script (e.g.
v4_13). Saved on blur.
Setup: configure the webhook https://api.flowcall.co/webhooks/ameyo/<accountId> in Ameyo, and set each agent's ameyo_user_id custom field to map Flowcall agents to their Ameyo user IDs.
Related
- Integrations — the broader connector library (channels, e-commerce, and the API).