How to add a private email service provider

Modified on Fri, 14 Jun 2024 at 04:48 AM

The private email service provider feature enables businesses to seamlessly integrate any email service provider of their choice, extending flexibility beyond the predefined options available. While NotifyVisitors offers a robust selection of integrated email service providers, we recognize that businesses may have unique preferences beyond these offerings.

For those seeking to engage with email service providers not included in our default options, this guide is tailored to your needs. Opting for the Private Service Provider option empowers you to manually add a service provider, ensuring a tailored integration experience that aligns precisely with your business requirements and preferences.

Integration Process for Private Email Service Providers

To integrate a private email service provider with NotifyVisitors, follow these steps:

First, navigate to the “Settings” section in your NotifyVisitors account. Select the “Email” section under channels and click on the “Service provider” tab. Then, select the “Add Service Provider" button to begin the setup process.

A new “Add Service Provider” window will appear. In the dropdown menu titled "Select Service Provider," opt for "Private ESP" to integrate a personalized service provider not initially provided by NotifyVisitors.

Now, proceed to input the necessary API details essential for creating a secure connection. Provide information such as Name, Endpoint URL, Request Type, Authentication, Body, and Header.

1. Name: First, assign a unique name to your private email service provider configuration. This name facilitates easy identification and management within your NotifyVisitors account.

2. Endpoint URL: Provide the Endpoint URL, which serves as the web address given by your private email service provider for seamless data exchange. This URL acts as a crucial link between NotifyVisitors and the email service.

3. Request Type: Next, select the request type, such as GET, POST, or PUT, as per your service provider’s documentation.

4. Basic authentication: Include Basic Authentication by inputting the credentials supplied by your private service provider. These credentials function as a secure key, ensuring that only authorized users can establish a connection and share data.

5. Body type: Proceed to the "Body Type" section, which determines how data is structured and transmitted between NotifyVisitors and the private email service provider. Choose between "Form Data" and "Plain Text" according to your provider's specifications.

- Form data: This option follows the traditional method of sending data in HTTP requests, organizing information as key-value pairs. Choose this if your private email service provider prefers structured data. Simply fill in the key section, select liquid tags from the dropdown menu in the value section, and click "Add More Field" to include additional key-value pairs.

- Plain text: This format simplifies the data exchange process by sending data as unformatted text. To include dynamic variables such as email, subject, message, etc., select the desired token by clicking "Choose Token.” A liquid tag will automatically be incorporated into the text, facilitating the integration of dynamic variables.

6. Headers: Here, define any specific headers or authentication tokens required for secure and authorized communication with the Private Email Service Provider.

7. Default email service provider: Lastly, choose the "Save as default" option to set this service provider as the default for sending broadcast email campaigns. If you want to set this provider as the default for email campaigns sent from journeys, select the "Save as default for journey" option.

Upon accurately filling in all the necessary details, click "Save" to finalize the configuration. This process seamlessly integrates your private service provider into your NotifyVisitors account, enabling you to utilize a customized email service provider tailored to your specific requirements.

Setting up delivery tracking configuration

Setting up delivery tracking is crucial for receiving delivery status reports for all the messages you send through your private email service provider (ESP). These reports provide valuable insights into the progress of your messages and ensure they reach your intended recipients.

After adding your ESP, navigate to the callback icon (fourth icon) under the action column to configure delivery callbacks.

Upon clicking the callback icon, a window will appear, offering several configuration options for setting up delivery callbacks. Follow a simplified three-step process:

Step 1: Integrate Delivery Tracking URL:

To begin receiving email delivery status updates, you need to set up the delivery tracking URL. There are two options for this:

Method A: Configure callback URL via Webhook

Configure the delivery tracking webhook endpoint in your ESP's dashboard to receive delivery status reports from your email service provider. Use the `dlr-callback-nv-reference` tag in the API request and map the corresponding response parameter in the webhook response.

Note

The webhook URL shown in the image is unique to each account. Please use the specific one provided in your account.

Method B: Configure callback URL via API request

In this method, you can directly set up the callback URL in the API request using the "dlr-callback-url" tag. This approach provides greater flexibility and adaptability for configuring the delivery tracking mechanism.

Instead of configuring the callback URL through a webhook, you can include the "dlr-callback-url" tag directly in the body of your API request. This tag specifies the URL where delivery status updates will be sent.

To implement this method effectively, refer to the API documentation provided by your email service provider. The documentation will offer detailed and specific instructions on how to incorporate the tags into your API request.

Step 2: Send test message

After configuring the delivery tracking URL, send a test email to ensure everything functions correctly. Click the "Send Test Message" button and provide the necessary body data. 

Note

The test email window will only show the fields that you’ve added in the body data while configuring private email service provider.

Step 3: Map Desired Attributes/Fields in the Delivery Response

After sending the test message, you'll promptly receive a response from your ESP. Use this response data to map the specific fields shown below to track email delivery effectively. Simply click on each field, and a dropdown menu will appear, displaying all the values from your test message response. Select the appropriate values based on the provided key.

Once these mappings are complete, click "Save" to finalize your delivery callback configuration. This one-time process ensures that when you create and send email campaigns through your private ESP, you'll receive delivery responses for all messages, indicating success or failure, along with details on any errors or reasons for failure.

Sending email campaigns via private ESP

To send email campaigns through a private email service provider (ESP) in NotifyVisitors, you'll need to follow a series of steps to ensure a smooth campaign setup:

Start by crafting an email campaign tailored to your specific needs. If you require assistance, you can refer to our detailed guide on "How to Create an Email Broadcast Campaign." Once you've entered the basic campaign information, navigate to the content section.

Locate the "Service Provider" dropdown menu and select "Private ESP" from the options. If you have added multiple private service providers, choose your specific provider from the next dropdown. Once selected, click on "Continue to Review."

On the review page you can also see that your private ESP is now selected. After confirming the details, proceed to send your campaign, which will then be routed through your private ESP.

Email Analytics

If you’ve configured your delivery tracking by following the steps mentioned above, then you’ll also be able to track the performance of your campaigns going through your private ESP, in a similar way as any other email campaign analytics in NotifyVisitors.

To learn more about email analytics, please refer to our article on "Email campaign report analytics."

Conclusion

Although NotifyVisitors provides a diverse range of email service providers, businesses often possess unique requisites. Integrating a private email service provider offers unparalleled adaptability, precisely catering to individual business specifications.

Was this article helpful?

That’s Great!

Thank you for your feedback

Sorry! We couldn't be helpful

Thank you for your feedback

Let us know how can we improve this article!

Select atleast one of the reasons
CAPTCHA verification is required.

Feedback sent

We appreciate your effort and will try to fix the article