Webhook

This page is under construction...

If your system is not listed among the supported data sources, but you have the technical capability to send POST requests from your system, you can use our Universal Webhook as a “bridge” to connect your data source to our system.

What is a Webhook? A webhook is a method for automatically exchanging information between systems. It allows one system (e.g., your database, telephony, ERP, or CRM system) to send data to another system (e.g., aiokk) as soon as an event occurs. In our case, the event should be the completion of a phone call.

How It Works

Set up your system to send us information about a new call via the webhook every time a phone call ends. You can configure your system to send data to our webhook only where it aligns with your business processes.

Setup in the account

Initial Configuration

To connect a third-party system via webhook, follow these steps in your personal account:

1. Go to Settings → Data Source and select Universal Webhook as the data source.

2. Copy the token, which you’ll use to generate the URL for POST requests.

Important Notes

1. Access to the data in your account is secured through verification with a unique token visible only in your personal account.

2. Never share your token with third parties! Technical support will never ask for your account token.

Token Replacement

If you need to change the token for any reason, use the dedicated button to generate a new one.

Critical Note: If you previously used the old token in your requests, the webhooks with the old token will stop working after regeneration. To restore functionality, you’ll need to replace the old token with the new one in all scenarios where the old webhook was used.

Composing the Request

POST https://{my.aiokk.domain}/api/v1/{token}/call/new

This method is designed to create a new call entry with detailed information about the call, employee, analytics tasks, and related data.

Preparing the Endpoint URL

To compose a correct endpoint URL, replace the following two placeholders in the provided URL: https://{my.aiokk.domain}/api/v1/{token}/call/new

1. {my.aiokk.domain}: This corresponds to the domain where your aiokk account is registered. To find your domain, log in to your aiokk account and check the domain in your browser’s address bar.

Example: In this case, it is my.aiokk.kz

1. {token}: This is the unique access token visible only on the Settings → Data Source page when the webhook is selected as the data source.

Headers

Name	Value
Content-Type	application/json

Request Body

The request body is a JSON object consisting of three main blocks: call, employee, and analytics.

Name	Type	Description

Response

200

{
}

400

{
}