| 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…).. |
The SmartReach.io modulesThe module is an application or tool within the Boost.space system. The entire system is built on this concept of modularity. (module - Contacts) allow you to watch, create, update, retrieve, and delete the prospects, campaigns, and emails in your SmartReach.io account.
Prerequisites
-
A SmartReach.io account
In order to use SmartReach.io with Boost.spaceCentralization and synchronization platform, where you can organize and manage your data. IntegratorPart of the Boost.space system, where you can create your connections and automate your processes., it is necessary to have a SmartReach.io account. If you do not have one, you can create a SmartReach.io account at app.smartreach.io/register.
![[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) 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., not in this documentation article) are mandatory! |
To connect your SmartReach.io account to Boost.space Integrator you need to obtain the API Key from your SmartReach.io account and insert it in the Create a connection dialog in the Boost.space Integrator module.
-
Log in to your SmartReach.io account and open your Dashboard.
-
Click Settings > AdminAdmins in Boost.space have exclusive access to system settings. They manage the overall system setup, including appearance, language, currency, user settings, and the availability of individual modules to users and teams. and Settings > Integrations.
-
Copy the API Key to your clipboard.
-
Go to Boost.space Integrator and open the SmartReach.io 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 and click Continue.
The connection has been established.
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 the prospect opt-out/unsubscribe.
|
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 |
See the Connecting to SmartReach.io Webhook using Boost.space Integratorto add the webhook in your SmartReach.io account.
Triggers when a prospect is marked as completed in a campaign.
|
Webhook Name |
Enter the name of the webhook. |
|
Connection |
See the Connecting to SmartReach.io Webhook using Boost.space Integratorto add the webhook in your SmartReach.io account.
Retrieves a list of prospects.
|
Connection |
|
|
Limit |
Set the maximum number of prospects 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).. |
Creates a new prospect.
|
Connection |
|
|
|
Enter the email address of the prospect. |
|
First Name |
Enter the first name of the prospect. |
|
Last Name |
Enter the last name of the prospect. |
|
City |
Enter the prospect’s city name. |
|
Company |
Enter the name of the company to which the userCan use the system on a limited basis based on the rights assigned by the admin. belongs. |
|
Country |
Enter the prospect’s country name. |
|
State |
Enter the prospect’s state name. |
|
List |
Enter the name of the list in which the prospect will be added. |
|
Timezone |
Select the timezone of the prospect. |
|
Custom FieldsA feature in Boost.space that allows you to define and manage data within each module according to your specific needs. |
Add the custom fields and set their values. |
Retrieves all campaigns.
|
Connection |
|
|
Limit |
Set the maximum number of campaigns Boost.space Integrator should return during one scenario execution cycle. |
Triggers when an email is sent.
|
Webhook Name |
Enter the name of the webhook. |
|
Connection |
See the Connecting to SmartReach.io Webhook using Boost.space Integratorto add the webhook in your SmartReach.io account.
Triggers when an email is opened.
|
Webhook Name |
Enter the name of the webhook. |
|
Connection |
See the Connecting to SmartReach.io Webhook using Boost.space Integratorto add the webhook in your SmartReach.io account.
Triggers when an email is marked as invalid.
|
Webhook Name |
Enter the name of the webhook. |
|
Connection |
Triggers when a new reply (from a prospect) is found.
|
Webhook Name |
Enter the name of the webhook. |
|
Connection |
See the Connecting to SmartReach.io Webhook using Boost.space Integratorto add the webhook in your SmartReach.io account.
Triggers when a link is clicked in any email.
|
Webhook Name |
Enter the name of the webhook. |
|
Connection |
See the Connecting to SmartReach.io Webhook using Boost.space Integratorto add the webhook in your SmartReach.io account.
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 campaigns from your SmartReach.io account:
URL:/v1/campaigns
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. > Body > data.
In our example, 2 campaigns were returned:
-
Open anyWatch module, enter the details as mentioned in the respective module, and copy the address to your clipboard.
-
Login to your SmartReach.io account, click Settings > Team Settings > Webhook Settings > Create your first webhook/Add new webhook.
-
Enter the URL address copied in step 1 and click Continue.
-
Select events you want to watch and click Start webhook to receive the alerts.
