Skip to main content

Integrating Optimove With a Third Party Vendor Execution Channel

Heather
  • Updated

Couldn't find the integration you're looking for in our existing integrations section?
Below are the steps for integrating a new third-party vendor.   

 

Please note:

This article covers pre-scheduled campaign execution channels only. For integrating a real-time execution channel, please contact your Customer Success Manager.

 

There are two ways to integrate Optimove with a third-party vendor:

1. The 3rd party integrates directly with Optimove

This is done by retrieving relevant campaign data via Optimove APIs. If you already have an agreement with the third party that they will develop the integration, please refer to the section below - “3rd party integrating directly to Optimove” section to get guidance on how to get started.
 

2. Build the execution channel integration on your own

This can be done either as middleware between Optimove and the third party or to integrate your in-house execution channel. If you will be developing the third-party vendor execution channel integration by yourself, please refer to the “Building the channel integration on your own” section below to get guidance on how to get started.
 

Third-Party Vendor Is Integrating Directly with Optimove

  1. Send this article to your contact person in the third-party company to follow its steps.
  2. Get the third party's credentials to our sandbox environment by submitting the sandbox API  request form in our Optimove Customer Portal (fill out the Optimove third-party vendor Access request).
  3. Optimove's Product Integration team will provide you with the sandbox credentials, and provide them to the third party.
  4. The third-party vendor should develop the integration using the sandbox credentials, test, and verify that everything works as expected.
  5. Update the sandbox request that you submitted so that a dedicated channel should now be created for the third party.
  6. Optimove's Product Integration team will provide you with a dedicated channel.
  7. Go to the Optimove Customer Portal, complete the production API (third-party vendor Access) form, and make sure to choose the dedicated channel that was provided to you.

    Please Note: Third-party API permissions are restricted to using APIs for campaign execution only. Therefore, the third-party vendor will not be able to access your customer data via the API. You might want the third party to get access to the specific customer attributes, for campaign execution and personalization purposes. If so, please list these attributes under “Enable Customer Attribute” in the request form.

  8. Optimove's Product Integration team will provide you with third-party production API credentials.
  9. Ask the third party to update the integration credentials to the production credentials provided to you.
  10. Test the integration using a test target group on your Optimove production site.

 

Building the channel integration on your own

  1. Follow this article when you are building the integration on your own.
  2. Get client credentials to our sandbox environment by submitting the sandbox API (Optimove Client Access) request form in our Optimove Customer Portal.
  3. Optimove's Product Integration team will provide you with the sandbox credentials.
  4. Develop the Integration using the sandbox credentials, test, and verify that everything works as expected.
  5. Go to the Optimove Customer Portal, and submit the production API (Optimove Client Access) form.
  6. Optimove's Product Integration team will provide you with credentials, and replace the previous sandbox credentials with these credentials.
  7. Test the integration using a test target group on your Optimove Production site.

|| Please note: if you’re acting as a middleware between Optimove and a 3rd party execution channel, makes sure to connect the third-party APIs as well to execute the campaign.

 

 

 

Managing Third-Party Subscriptions in Optimove

Optimove supports three ways third-party platforms can share customer opt-in statuses.

Real-time API calls

You can use two real-time API calls to share your customer subscription data with Optimove.

As a first step, you will need to call the Add Customer Attribute API to create the attributes as you would like to see them in your Optimove instance (e.g., Mobile Push Opt-in).
 
The second step is to populate that attributes for all customers, using the UpdateCustomerAttributes API (note there is a limit of 10,000 customers per call).
 

|| Note: in order to use this option, you will need to have an API user with client permissions for your Optimove instance.

 

Designated API call for a specific channel

You can upload a list of customers and their opt-in status using the Set Customer Channel Preference API (note there is a limit of 50,000 customers per call).

This API will populate a table in Optimove’s backend which will then be used to create an opt-in status attribute.
 
When using this setup you will need to work with your CSM to have the new attribute created for you.
 

The batch process was sent to Optimove

You can share this data as part of your batch process, either as an opt-in column within your "customers" table or as a separate standalone file of subscription users.

 

For further information regarding the options above please contact your CSM. 

Related articles