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.
See Experience Email for information about ESP integration for email campaigns.
Prerequisites
- Your ESP must support RESTful APIs, with one of the following authentication methods:
- No authentication
- Basic authentication
- OAuth2.0
- 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
- Go to Settings › Integration and locate Non-listed Email Provider.
- Turn on the Enable Integration toggle in the right pane.
- Select the Identifier Type you want to use in your ESP to identify users: 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 email addresses, and you'll manage opted-in users by firing Message Opt-in and Opt-out events.
- Implement an Identify User 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 to these events.
- Select the authentication type depending on your ESP requirements:
- No Authentication (No Auth): No authentication type is used. If you select this option, 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 issued by an authorization server to connect to your ESP. The receiving endpoint checks the authentication token when accepting the HTTP request. The integration uses a Client credentials type, which requires:
- Client ID and Client Secret: Equivalent to username and password. Dynamic Yield uses them 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.
- HTTP Header Parameters: Define the header parameters – the HTTP header settings used when sending the actual POST request. Some endpoints might 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”
- Verify that the request is formatted properly by going to the Test tab, sending a test email, and viewing the server response. You must enter a valid JSON payload for the test API call to succeed.
- Click Save Settings.