| Active with remarks |
|---|
| This application needs additional settings. Please follow the documentation below to create your connection. |
The Sendinblue integrator. Designed to work with data inside the application.']module[/tooltip]s allow you to watch, create, update, list, and delete the contacts, lists, folders, email campaigns, events, emails, and SMS in your Sendinblue account.
Prerequisites
-
A Sendinblue account
In order to use Sendinblue with Boost.space Integrator, it is necessary to have a Sendinblue account. If you do not have one, you can create a Sendinblue account at sendinblue.com/register.
![[Caution]](https://docs.boost.space/wp-content/uploads/2022/11/caution.png) |
Caution |
|---|---|
|
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 Sendinblue account to Boost.space Integrator you need to obtain the API Key from your Sendinblue account and insert it in the Create a connection dialog in the Boost.space Integrator module.
1. Log in to your Sendinblue account.
2. Click your Profile Icon > SMTP&API.
3. Copy the API v3 to your clipboard.
4. Go to Boost.space Integrator and open the Sendinblue module’s Create a connection dialog.
5. In the Connection name field, enter a name for the connection.
6. In the API Key field, enter the API key copied in step 4 and click Continue.
The connection has been established.
Triggers when a new contact is created.
|
|
|
|
|
Enter the maximum number of contacts Boost.space Integrator should return during one scenario execution cycle. |
Lists all contacts.
|
|
|
|
|
Enter the date to list the contacts that were changed or updated on or after the specified date. |
|
|
Enter the maximum number of contacts Boost.space Integrator should return during one scenario execution cycle. |
Lists lists in a folder.
|
|
|
|
|
Select the folder whose contact lists you want to list. |
|
|
Enter the maximum number of contacts Boost.space Integrator should return during one scenario execution cycle. |
Lists all contacts in a list.
|
|
|
|
|
Select the list whose contacts you want to list. |
|
|
Enter the date to list the contacts that were changed or updated on or after the specified date. |
|
|
Enter the maximum number of contacts Boost.space Integrator should return during one scenario execution cycle. |
Return details about a contact.
|
|
|
|
|
Enter the email address of the contact whose details you want to retrieve. |
Adds existing contacts to a list.
|
|
|
|
|
Select the list to which you want to add an existing contact. |
|
|
Add the email address you want to add to the list:
Enter the email address of the contact. |
Crates a contact.
|
|
|
|
|
Enter the email address of the contact. |
|
|
Enter the last name of the contact. |
|
|
Enter the first name of the contact. |
|
|
Enter the phone number with country code to receive the SMS. |
|
|
Select the list to which you wanted to add the contact. |
|
|
Select whether the email address is blacklisted:
|
|
|
Select whether the SMS number is blacklisted:
|
|
|
Select whether the contact update is enabled:
|
|
|
Add the email address transactions forbidden from the sender. This is applicable only if you enabled the update for the contact. |
Updates the contact.
|
|
|
|
|
Enter the email address of the contact. |
|
|
Enter the last name of the contact. |
|
|
Enter the first name of the contact. |
|
|
Enter the phone number with country code to receive the SMS. |
|
|
Select the list to which you wanted to add the contact. |
|
|
Select the list from which you want to remove the contact. |
|
|
Select whether the email address is blacklisted:
|
|
|
Select whether the SMS number is blacklisted:
|
|
|
Select whether the contact update is enabled:
|
|
|
Add the email address transactions forbidden from the sender. This is applicable only if you enabled the update for the contact. |
Deletes a contact.
|
|
|
|
|
Enter the email address you want to delete. |
Triggers when a new list is created.
|
|
|
|
|
Enter the maximum number of lists Boost.space Integrator should return during one scenario execution cycle. |
Lists all lists.
|
|
|
|
|
Enter the maximum number of lists Boost.space Integrator should return during one scenario execution cycle. |
Returns details about a list.
|
|
|
|
|
Select the List ID whose details you want to retrieve. |
Creates a list.
|
|
|
|
|
Select the folder in which you want to create the list. |
|
|
Enter the name of the list. |
Updates a list.
|
|
|
|
|
Select the Folder ID whose list you want to update. |
|
|
Select the option you want to update:
|
|
|
Enter a new name for the list. |
|
|
Select the folder to which you want to move the list. |
Deletes a list.
|
|
|
|
|
Select the List ID you want to delete. |
Triggers when a new folder is created.
|
|
|
|
|
Enter the maximum number of folders Boost.space Integrator should return during one scenario execution cycle. |
Lists all folders.
|
|
|
|
|
Enter the maximum number of folders Boost.space Integrator should return during one scenario execution cycle. |
Returns details about a folder.
|
|
|
|
|
Select the Folder ID whose details you want to retrieve. |
Creates a folder.
|
|
|
|
|
Enter the name of the folder. |
Updates a folder.
|
|
|
|
|
Select the Folder ID you want to update. |
|
|
Enter a new name for the folder. |
Deletes a folder.
|
|
|
|
|
Select the Folder ID you want to delete. |
Triggers when a new email campaign is created.
|
|
|
|
|
Select the email campaign type you want to watch:
|
|
|
Select the status email campaigns you want to watch:
|
|
|
Enter the maximum number of folders Boost.space Integrator should return during one scenario execution cycle. |
List all email campaigns.
|
|
|
|
|
Select the email campaign type you want to watch:
|
|
|
Select the status email campaigns you want to watch:
|
|
|
Enter the start date of the campaign. |
|
|
Enter the date of the campaign. |
|
|
Enter the maximum number of campaigns Boost.space Integrator should return during one scenario execution cycle. |
Creates a new campaign.
|
|
|
|
|
Enter the name of the email campaign. |
|
|
Select the sender option:
|
|
|
Enter the email address from which you will send the campaign. |
|
|
Enter the name that appears when you send the campaign email. |
|
|
Select the email address from which you will send the campaign. |
|
|
Enter the body message of the email campaign. |
|
|
Enter the HTML URL of the email message. |
|
|
Select the template for the email campaign. |
|
|
Enter the subject line of the email campaign. |
|
|
Enter the keywords that filter the email campaigns when searching. |
|
|
Enter the date and time when the email campaign is scheduled to send. |
|
|
Enter the email address to which the campaign recipients can reply to. |
|
|
Enter the email address or first name or last name of the recipient. |
|
|
Select the list in which the recipient email address exists. |
|
|
Select the list to which you do not want to send the campaign. |
|
|
Enter the file attachment URL which you want to send along with the campaign. For example, |
|
|
Select whether you want to display the images in the campaign:
|
|
|
Select whether you want to activate the mirror link:
|
|
|
Enter the header of the email campaign. |
|
|
Enter the footer of the email campaign. |
|
|
Enter the UTM campaign value. If no value is provided, the campaign name will be used. You can enter alphanumeric characters. |
|
|
Add any additional parameters:
Enter the name of the parameter. For example,
Enter the value of the parameter. For example, |
|
|
Select whether you want to send the campaign at the best time:
|
|
|
Select whether you want to perform the A/B testing of the campaign before sending:
|
|
|
Enter the variant A value. |
|
|
Enter the Variant B value. |
|
|
Enter the size of the test groups with whom you are performing A/B tests. |
|
|
Enter the details of the winning criteria. Mandatory if splitRule >= 1 and < 50. If splitRule = 50, ‘winnerCriteria’ is ignored if passed. |
|
|
Enter the duration of the test in hours by which you want to delay. You can delay a maximum of seven days or 168 hours. The winning version will be sent at the end of the test. Mandatory if splitRule >= 1 and < 50. If splitRule = 50, ‘WinnerDelay’ is ignored if passed. |
|
|
Select whether you want to enable IP warmup:
|
|
|
Enter an initial quota greater than 1 for warming up your IP. We recommend you set a value of 3000. |
|
|
Enter the increase value in percentage. This field is mandatory if you have select yes for the IP warm up. Enter the percentage increase rate. It is recommended to set the increase rate to 30% per day. If you want to send the same number of emails everyday, then set the daily increase value as 0%. |
Returns details about an email campaign.
|
|
|
|
|
Select the Campaign ID whose details you want to retrieve. |
Updates an email campaign.
|
|
|
|
|
Enter the Campaign ID you want to update. You can get the Campaign ID by using the Get Campaign ID module. |
|
|
Enter the name of the email campaign. |
|
|
Select the sender option:
|
|
|
Enter the email address from which you will send the campaign. |
|
|
Enter the name that appears when you send the campaign email. |
|
|
Select the email address from which you will send the campaign. |
|
|
Enter the body message of the email campaign. |
|
|
Enter the HTML URL of the email message. |
|
|
Select the template for the email campaign. |
|
|
Enter the subject line of the email campaign. |
|
|
Enter the keywords that filter the email campaigns when searching. |
|
|
Enter the date and time when the email campaign is scheduled to send. |
|
|
Enter the email address to which the campaign recipients can reply to. |
|
|
Enter the email address or first name or last name of the recipient. |
|
|
Select the list in which the recipient email address exists. |
|
|
Select the list to which you do not want to send the campaign. |
|
|
Enter the file attachment URL which you want to send along with the campaign. For example, |
|
|
Select whether you want to display the images in the campaign:
|
|
|
Select whether you want to activate the mirror link:
|
|
|
Enter the header of the email campaign. |
|
|
Enter the footer of the email campaign. |
|
|
Enter the UTM campaign value. If no value is provided, the campaign name will be used. You can enter alphanumeric characters. |
|
|
Add any additional parameters:
Enter the name of the parameter. For example,
Enter the value of the parameter. For example, |
|
|
Select whether you want to send the campaign at the best time:
|
|
|
Select whether you want to perform the A/B testing of the campaign before sending:
|
|
|
Enter the variant A value. |
|
|
Enter the Variant B value. |
|
|
Enter the size of the test groups with whom you are performing A/B tests. |
|
|
Enter the details of the winning criteria. Mandatory if splitRule >= 1 and < 50. If splitRule = 50, ‘winnerCriteria’ is ignored if passed. |
|
|
Enter the duration of the test in hours by which you want to delay. You can delay a maximum of seven days or 168 hours. The winning version will be sent at the end of the test. Mandatory if splitRule >= 1 and < 50. If splitRule = 50, ‘WinnerDelay’ is ignored if passed. |
|
|
Select whether you want to enable IP warmup:
|
|
|
Enter an initial quota greater than 1 for warming up your IP. We recommend you set a value of 3000. |
|
|
Enter the increase value in percentage. This field is mandatory if you have selected yes for the IP warm up. Enter the percentage increase rate. It is recommended to set the increase rate to 30% per day. If you want to send the same number of emails everyday, then set the daily increase value as 0%. |
Deletes an email campaign.
|
|
|
|
|
Select the Campaign ID you want to delete. |
Triggers when a new email event occurs.
|
|
Enter a name for the webhook. |
||||||||||||||||||||||||||
|
|
|||||||||||||||||||||||||||
|
|
Select the event type for which you want to receive the notifications:
|
||||||||||||||||||||||||||
|
|
Select the event for which you want to receive the notifications.
|
See the Connecting to Sendinblue Webhook using Boost.space Integrator to add the webhook in your Sendinblue account.
Sends a transactional email.
|
|
|
|
|
Enter the name of the sender who is sending the SMS. |
|
|
Enter the recipient’s phone number along with the country code. |
|
|
Enter the message text. |
|
|
Select the SMS type:
|
|
|
Enter the webhook details if applicable. |
|
|
Enter the keyword to filter the SMS when searching. |
Sends a transactional email.
|
|
|
|
|
Select the template for the email. |
|
|
Add the email addresses to which you want to send an email:
Enter the name of the person.
Enter the email address of the person. |
|
|
Enter the subject line of the email. |
|
|
Enter the email message. |
|
|
Enter the email message if you have not selected any template for the email. |
|
|
Enter the name of the person to which the email recipient can reply to. |
|
|
Enter the email address of the person to which the email recipient can reply to. |
|
|
Add the attachments of the email:
Select the attachment type:
Enter the file name with the file extension. For example,
Enter the attachment or image URL address.
Enter the file data to the field or map the source of the file. |
|
|
Add the email addresses which you want to add in BCC field of the email:
Enter the name of the contact
Enter the email address of the contact. |
|
|
Add the email addresses which you want to add in CC field of the email:
Enter the name of the contact.
Enter the email address of the contact. |
|
|
Enter the name of the sender. |
|
|
Enter the email address of the sender. |
|
|
Enter the email header. Pass the set of custom headers (not the standard headers) that shall be sent along with the mail headers in the original email. ‘sender.ip’ header can be set (only for dedicated IP users) to mention the IP to be used for sending transactional emails. Headers are allowed in |
|
|
Enter the keywords as tags to filter the emails when searching. |
|
|
Add any additional parameters:
Enter the name of the parameter. For example,
Enter the value of the parameter. For example, |
Sends a PDF campaign report to the specific email.
|
|
|
|
|
Select the campaign whose report you want to send. |
|
|
Enter the subject line of the email. |
|
|
Add the email address to whom you are sending the email:
Enter the email address of the recipient. |
|
|
Select the content-type:
|
|
|
Enter the email body text. |
|
|
Add the email addresses which you want to add in BCC field of the email:
Enter the name of the contact
Enter the email address of the contact. |
|
|
Add the email addresses which you want to add in CC field of the email:
Enter the name of the contact
Enter the email address of the contact. |
|
|
Select the language in which you want to send the email with the campaign report. |
Performs an arbitrary authorized API call.
|
|
|
|
|
Enter a path relative to For the list of available endpoints, refer to the Sendinblue API Documentation. |
|
|
Select the HTTP method you want to use:
|
|
|
Enter the desired request headers. You don’t have to add authorization headers; we already did that for you. |
|
|
Enter the request query string. |
|
|
Enter the body content for your API call. |
The following API call returns all tasks from your CloudFront account:
URL:
/v3/emailCampaigns
Method:
GET
Matches of the search can be found in the module’s Output under Bundle > Body > data.
In our example, 1 campaign is returned:
Return details about my account.
1. In the Boost.space Integrator, New Event module, enter the details as mentioned in the New Event and copy the address to your clipboard.
2. Login to your Sendinblue account. From the left menu, click Settings > Webhook (configure).
3. Click Add Webhook.
4. In the URL to post to field, enter the URL address copied in step 1, select the events you want to watch,, add any details about the webhook, and click Add.
The webhook is added successfully.
Do you need help with something specific regarding Sendinblue?
We are here for you.
Get support on the road to success from real experts.
We will help you set up your business processes, create connections from your current IT stack, and set up data analysis.
Get in touch