| 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 Toky 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 create, update, list, and retrieve the agents, contacts, text messages, and voicemails in your Toky account.
Prerequisites
-
A Toky account
In order to use Toky 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 Toky account. If you do not have one, you can create a Toky account at app.toky.co/signup?.
![[Note]](https://bs-docs2.boost.space/wp-content/themes/bsdocs/docs-parser/HTML/css/image/note.png) |
Note |
|---|---|
|
You do not have to add the webhooksA webhook is a way for an app to send real-time information to a specific URL in response to certain events or triggers. in the Toky as it is automatically done for you once you add and save an instant 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... 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 to your scenarioA specific connection between applications in which data can be transferred. Two types of scenarios: active/inactive. More. |
To connect your Toky account to Boost.space Integrator you need to obtain the API Key from your Toky account and insert it in the Create a connection dialog in the Boost.space Integrator module.
1. Log in to your Toky account and open your Dashboard.
2. Click Your Profile Icon > API Keys > Show > Copy and Close.
3. Go to Boost.space Integrator and open the Create a connection dialog.
4. In the Connection name field, enter a name for the connection.
5. In the API Key field, enter the API key copied in step 2, and click Continue.
The connection has been established.
Retrieves all agents from a Toky account.
|
Connection |
|
|
Limit |
Set the maximum number of agent 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).. |
Gets all contacts from the phone directory.
|
Connection |
|
|
Limit |
Set the maximum number of contacts Boost.space Integrator should return during one scenario execution cycle. |
Gets contact.
|
Connection |
|
|
Phone Number |
Select the phone number whose contact details you want to retrieve. |
Creates a new contact in the phone directory.
|
Connection |
|
|
Created By |
Select the member’s email address who is creating the contact. |
|
First Name |
Enter the first name of the contact. |
|
Last Name |
Enter the last name of the contact. |
|
Phone Number |
Enter the phone number of the contact including the country code. For example, |
|
|
Enter the email address of the contact. |
Updates contact.
|
Connection |
|
|
Phone Number |
Enter the phone number of the contact whose details you want to update. |
|
First Name |
Enter the first name of the contact. |
|
Last Name |
Enter the last name of the contact. |
|
|
Enter the email address of the contact. |
|
Company Name |
Enter the company name to which the contact is associated with. |
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 there is a new incoming text message in Toky.
|
Note |
|---|---|
|
You do not have to add the webhooks in the Toky as it is automatically done for you once you add and save an instant trigger module to your scenario. |
|
WebhookA webhook is a way for an app to send real-time information to a specific URL in response to certain events or triggers. Name |
Enter the name of the webhook. |
|
Connection |
List text messages historyBoost.space Integrator maintains a history of your scenario and records: The date that scenario execution started Status (success, warning, or error) Execution duration Number of operations spent during the scenario run Size of transferred data Link to detailed information, where you can inspect all data in that particular execution received and how the data was processed You can view this... sent, and received. The result is ordered by descending date.
|
Connection |
|
|
Limit |
Set the maximum number of text messages Boost.space Integrator should return during one scenario execution cycle. |
Sends a text message.
|
Connection |
|
|
From |
Enter the Toky number from which you want to send the SMS. It must be an SMS enabled number. |
|
To |
Enter the number to which you want to send the SMS. |
|
Text |
Enter the message text you want to send. |
|
|
Enter the email address of the Toky agent who is sending the message. |
Triggers when there is a new call in the Toky.
|
Note |
|---|---|
|
You do not have to add the webhooks in the Toky as it is automatically done for you once you add and save an instant trigger module to your scenario. |
|
Webhook Name |
Enter the name of the webhook. |
|
Connection |
Triggers when there is a new voicemail in the Toky.
|
Note |
|---|---|
|
You do not have to add the webhooks in the Toky as it is automatically done for you once you add and save an instant trigger module to your scenario. |
|
Webhook Name |
Enter the name of the webhook. |
|
Connection |
List voicemail history. The result is ordered by descending created date.
|
Connection |
|
|
Limit |
Set the maximum number of voicemails 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 contacts from your Toky account:
URL: /v1/contacts
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 > results.In our example, 3 contacts were returned:
