| Active with remarks |
|---|
| This application needs additional settings. Please follow the documentation below to create your own connection. |
The CallRail modules allow you to watch the pre-calls, modified calls, SMS, users, trackers, companies, and calls in your CallRail account.
Prerequisites
-
A CallRail account
In order to use CallRail with Boost.space Integrator, it is necessary to have a CallRail account. If you do not have one, you can create a CallRail account at callrail.com.
![[Note]](https://docs.boost.space/wp-content/themes/bsdocs/docs-parser/HTML/css/image/note.png) |
Note |
|---|---|
|
The module dialog fields that are displayed in bold (in the Boost.space Integrator scenario, not in this documentation article) are mandatory! |
To connect your CallRail account to Boost.space Integrator you need to obtain the API Key from your CallRail account and insert it in the Create a connection dialog in the Boost.space Integrator module.
-
Log in to your CallRail account.
-
Click Your Account Name > My Profile > API Keys > Create API V3 Key.
-
Copy the API Key to your clipboard.
-
Go to Boost.space Integrator and open the CallRail module’s Create a connection dialog.
-
In the Connection name field, enter a name for the connection.
-
In the API Key field, enter the API Key copied in step 3.
-
In the Account ID field, enter your 9-digit account ID without any special characters. You can find the Account ID when you click Your Account Name. For example,
713863719. -
Click Continue.
The connection has been established.
See the Setting Up the CallRail Webhooks to add the webhook in your CallRail account.
Triggers when an inbound phone call is received by CallRail.
|
Webhook Name |
Enter a name for the webhook. |
|
Connection |
Triggers when a call has changed after it’s ended.
|
Webhook Name |
Enter a name for the webhook. |
|
Connection |
Triggers when an SMS message is received.
|
Webhook Name |
Enter a name for the webhook. |
|
Connection |
Triggers when an SMS message is sent.
|
Webhook Name |
Enter a name for the webhook. |
|
Connection |
Triggers when a new tracker is created.
|
Connection |
|
|
Limit |
Set the maximum number of trackers Boost.space Integrator should return during one scenario execution cycle. |
Triggers when a new company is created.
|
Connection |
|
|
Limit |
Set the maximum number of companies Boost.space Integrator should return during one scenario execution cycle. |
Triggers when a new user is created.
|
Connection |
|
|
Limit |
Set the maximum number of users Boost.space Integrator should return during one scenario execution cycle. |
Performs an arbitrary authorized API call.
|
Connection |
||||
|
URL |
Enter a path relative to
|
|||
|
Method |
Select the HTTP method you want to use: GET to retrieve information for an entry. POST to create a new entry. PUT to update/replace an existing entry. PATCH to make a partial entry update. DELETE to delete an entry. |
|||
|
Headers |
Enter the desired request headers. You don’t have to add authorization headers; we already did that for you. |
|||
|
Query String |
Enter the request query string. |
|||
|
Body |
Enter the body content for your API call. |
Triggers when an inbound phone call is received or a call has changed after it’s ended.
|
Webhook Name |
Enter a name for the webhook. |
|
Connection |
|
|
Company ID |
Select the Company ID whose call you want to watch. |
-
Open anyWatchmodule, enter the details as provided in the respective module, click Save and copy the URL address to your clipboard.
-
Log in to your CallRail account. Click Settings > Manage >Add Integration > Webhooks.
-
Select the company for which you add the trigger.
-
In the required event field, add the URL address copied in step 1, and click Update.
