| Active with remarks |
|---|
| This application needs additional settings. Please follow the documentation below to create your own connection. |
The SendX modules allow you to watch, create, update, list, retrieve, and delete the contacts, and tags in your SendX account.
Prerequisites
-
A SendX account
In order to use SendX with Boost.space Integrator, it is necessary to have a SendX account. If you do not have one, you can create a SendX account at app.sendx.io/register.
![[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 SendX account to Boost.space Integrator you need to obtain the API Key from your SendX account and insert it in the Create a connection dialog in the Boost.space Integrator module.
-
Log in to your SendX account.
-
Click Your Account Name > Settings.
-
Copy the Team ID and API Key to a safe place.
-
Go to Boost.space Integrator and open the SendX module’s Create a connection dialog.
-
In the Connection name field, enter a name for the connection.
-
In the Team ID and API Key fields, enter the team ID and API key details copied in step 3, and click Continue.
The connection has been established.
Creates or updates a contact.
|
Connection |
|
|
|
Enter the contact’s email address which you want to create or update. |
|
New Email |
Enter the new email address if you are updating the details of an existing contact. |
|
First Name |
Enter the contact’s first name. |
|
Last Name |
Enter the contact’s last name. |
|
Birthday |
Enter the contact’s date of birth. |
|
Company |
Enter the contact’s company name. |
|
Tags |
Enter the contact’s tags. |
|
Custom Fields |
Add the custom field key and its value. |
Adds a tag to a contact.
|
Connection |
|
|
|
Enter the contact’s email address for whom you want to add. |
|
Tag |
Enter the tag name which you want to add to the contact. |
Removes a tag from a contact.
|
Connection |
|
|
|
Enter the contact’s email address whose tag you want to remove. |
|
Tag |
Enter the tag name which you want to remove. |
Triggers when the entity to which you attached the webhook is executed.
|
Webhook Name |
Enter a name for the webhook. |
|
Connection |
See the Setting Up the SendX Webhooks to add the webhook in your SendX 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 identifies and returns the details of the specified contact from your SendX account:
URL:
/v1/contact/identify
Method:
POST
Body:
{ "email":
"<email_address_of_the_contact>"
}
Matches of the search can be found in the module’s Output under Bundle > Body > data.
In our example, the specified contacts details were returned:
-
Open the Universal Trigger module, establish a connection, click Save and copy the URL address to your clipboard. Click OK and save the trigger.
-
Log in to your SendX account. Click Automation > Create New Automation.
-
In the Trigger section, select the option, and its value for which you want to receive the trigger.
-
In the Action section, select Call Webhook, and add the URL address copied in step 1. Click Submit Automation.
You have successfully added the webhook to the SendX account.
Go to Boost.space Integrator and run the trigger. You will receive alerts for added triggers. For example, here you receive the triggers when a user subscribes to the Support list.