SmartReach.io
The SmartReach.io modules allow you to watch, create, update, retrieve, and delete the prospects, campaigns, and emails in your SmartReach.io account.
Getting Started with SmartReach.io
Prerequisites
- A SmartReach.io account
In order to use SmartReach.io with Boost.space Integrator, 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.
The module dialog fields that are displayed in bold (in the Boost.space Integrator scenario, not in this documentation article) are mandatory!
Connecting SmartReach.io to Boost.space Integrator
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 > Admin 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.
Prospect
Watch Prospect Opt Out
Triggers when the prospect opt-out/unsubscribe.
Webhook Name
Enter the name of the webhook.
Connection
Establish a connection to your SmartReach.io account.
See the Connecting to SmartReach.io Webhook using Boost.space Integratorto add the webhook in your SmartReach.io account.
Watch Prospect Completed
Triggers when a prospect is marked as completed in a campaign.
Webhook Name
Enter the name of the webhook.
Connection
Establish a connection to your SmartReach.io account.
See the Connecting to SmartReach.io Webhook using Boost.space Integratorto add the webhook in your SmartReach.io account.
List Prospects
Retrieves a list of prospects.
Connection
Establish a connection to your SmartReach.io account.
Limit
Set the maximum number of prospects Boost.space Integrator should return during one scenario execution cycle.
Create a Prospect
Creates a new prospect.
Connection
Establish a connection to your SmartReach.io account.
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 user 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 Fields
Add the custom fields and set their values.
Campaign
List Campaigns
Retrieves all campaigns.
Connection
Establish a connection to your SmartReach.io account.
Limit
Set the maximum number of campaigns Boost.space Integrator should return during one scenario execution cycle.
Watch Email Sent
Triggers when an email is sent.
Webhook Name
Enter the name of the webhook.
Connection
Establish a connection to your SmartReach.io account.
See the Connecting to SmartReach.io Webhook using Boost.space Integratorto add the webhook in your SmartReach.io account.
Watch Email Opened
Triggers when an email is opened.
Webhook Name
Enter the name of the webhook.
Connection
Establish a connection to your SmartReach.io account.
See the Connecting to SmartReach.io Webhook using Boost.space Integratorto add the webhook in your SmartReach.io account.
Watch Email Invalid
Triggers when an email is marked as invalid.
Webhook Name
Enter the name of the webhook.
Connection
Establish a connection to your SmartReach.io account.
Watch New Reply
Triggers when a new reply (from a prospect) is found.
Webhook Name
Enter the name of the webhook.
Connection
Establish a connection to your SmartReach.io account.
See the Connecting to SmartReach.io Webhook using Boost.space Integratorto add the webhook in your SmartReach.io account.
Watch Email Link Clicked
Triggers when a link is clicked in any email.
Webhook Name
Enter the name of the webhook.
Connection
Establish a connection to your SmartReach.io account.
See the Connecting to SmartReach.io Webhook using Boost.space Integratorto add the webhook in your SmartReach.io account.
Other
Make an API Call
Performs an arbitrary authorized API call.
Connection
Establish a connection to your SmartReach.io account.
URL
Enter a path relative to https://api.smartreach.io/api. For example: /v1/prospects
For the list of available endpoints, refer to the SmartReach.io API Documentation.
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.
Example of Use – List Campaigns
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 Bundle > Body > data.
In our example, 2 campaigns were returned:
Connecting to a SmartReach.io Webhook using Boost.space Integrator
-
Open any_Watch_ 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 Setting_s > 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.
Legacy article, imported from the original Boost.space knowledge base (/knowledge-base/applications/marketing/smartreach-io/).
