| Active with remarks |
|---|
| This application needs additional settings. Please follow the documentation below to create your own connectionUnique, active service acces point to a network. There are different types of connections (API key, Oauth…). More. |
The CallRail modulesThe module is an application or tool within the Boost.space system. The entire system is built on this concept of modularity. (module - Contacts) More allow you to watch the pre-calls, modified calls, SMS, usersCan use the system on a limited basis based on the rights assigned by the admin. More, trackers, companies, and calls in your CallRail account.
Prerequisites
-
A CallRail account
In order to use CallRail with Boost.spaceCentralization and synchronization platform, where you can organize and manage your data. More IntegratorPart of the Boost.space system, where you can create your connections and automate your processes. More, 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 moduleThe module is an application or tool within the Boost.space system. The entire system is built on this concept of modularity. (module - Contacts) More dialog fields that are displayed in bold (in the Boost.space Integrator scenarioA specific connection between applications in which data can be transferred. Two types of scenarios: active/inactive. More, 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 webhookA webhook is a way for an app to send real-time information to a specific URL in response to certain events or triggers. in your CallRail account.
TriggersEvery scenario has a trigger, an event that starts your scenario. A scenario must have a trigger. There can only be one trigger for each scenario. When you create a new scenario, the first module you choose is your trigger for that scenario. Create a trigger by clicking on the empty module of a newly created scenario or moving the... 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 cycleA cycle is the operation and commit/rollback phases of scenario execution. A scenario may have one or more cycles (one is the default).. |
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. |
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. |
The following API call returns all the companies from your CallRail account:
URL
/v3/a/Account_ID/companies.json
Method
GET
Matches of the search can be found in the module’s Output under BundleA bundle is a chunk of data and the basic unit for use with modules. A bundle consists of items, similar to how a bag may contain separate, individual items. More > Body > companies.
In our example, 5 companies were returned:
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 > WebhooksA webhook is a way for an app to send real-time information to a specific URL in response to certain events or triggers..
-
Select the company for which you add the triggerEvery scenario has a trigger, an event that starts your scenario. A scenario must have a trigger. There can only be one trigger for each scenario. When you create a new scenario, the first module you choose is your trigger for that scenario. Create a trigger by clicking on the empty module of a newly created scenario or moving the....
-
In the required event field, add the URL address copied in step 1, and click Update.
