ESP Integration for Triggered Emails

Dynamic Yield offers several native integrations with popular ESPs. However, if your ESP has no native integration, you might be able to integrate it with our custom integration.

Prerequisites

• Your ESP must support RESTful APIs.
• Triggered emails must be enabled for your account. If they aren't, contact your Customer Success Manager to enable it.

Configure a custom ESP integration

1. Go to Settings › Integration and locate Non-listed Email Provider.
   
   
   
2. Turn on the Enable Integration toggle. 
3. Select the Identifier Type you want to use in your ESP to identify user identity: Email address (plain text) or External (any string that your ESP can map to an email address).
   

   If you use External ID:

   • You can't use the User Email feed to upload emails, and you'll manage opted-in users by firing Message Opt-in and Opt-out events.
   • Implement an Identify API event on your site. If you already have Login, Signup, or Subscribe to Newsletter events implemented on your site, you'll need to implement the Identify event in parallel with these events.
4. Select the authentication type depending on your ESP requirements 
   • No Authentication (No Auth): No authentication type is used. if chosen, sending any header parameters, including API keys, is optional.
   • Basic Authentication (Basic Auth): Requires the username and password credentials of the HTTP endpoint of the ESP. When data is sent, the Basic Auth fields are included in the header of the HTTP request. Enter the HTTP POST URL. This is where Dynamic Yield sends the POST request. A variable ${dyCampaignName} can be used and is replaced with each campaign name that triggers the endpoint.
   • OAuth 2.0: Requires an authentication token, which is issued by an authorization server, in order to connect to your ESP. The authentication token is checked by the receiving endpoint when accepting the HTTP request. The integration uses a Client credentials type, which requires:
     
     • Client ID and Client Secret: Parallel to username and password. Dynamic Yield uses this to request the authentication token from your authorization server.
     • Token URL: The URL of the authorization server from which Dynamic Yield requests the token.
       • Header and body parameters (optional): Additional parameters can be added to authentication tokens. These might require including header or body parameters in the token call. You can add up to 5 header or body parameters. 
     • Endpoint: This is where Dynamic Yield sends the POST request. A variable ${dyCampaignName} can be used and is replaced with each campaign name that triggers the endpoint.
5. HTTP Header Parameters: Define the header parameters which are the HTTP header settings used when sending the actual POST request. Certain endpoints may require that you include headers in your request. Common use cases for request headers include a content-type specification (JSON) and authorization headers that contain your credentials with your vendor or system. For example, content type specifications have the key “Content-Type” and common values are “application/json”
6. Verify that the request is formatted properly by going to the Test tab and sending a test email and viewing the server response.
7. Click Save Settings. 

Further reading

• Creating Triggered Email Campaigns
• Enabling Triggered Emails