The Optimizely Campaign Make integration

11 min

Basics

Purpose

Make is an automation platform for connecting various applications and services to automate tasks. Please refer to the Make user documentation for learning about Make, the page Create your first scenario provides a good starting point. Here, the focus is on using Optimizely Campaign as an app within make. You should understand the basics of Make before continuing.

Using the webhooks provided in the Campaign app within Make is free of charge.

Triggers and Actions

The Optimizely Campaign app in Make provides two types of objects:

Triggers based on events in Optimizely Campaign that can be used to control Make scenarios (workflows),

Actions in Optimizely Campaign that can be used in a scenario.

When adding a module to your scenario in Make, search for "Optimizely Campaign" to see the triggers and actions from Campaign.

Requirements

User Account

Following conditions are required for using the Optimizely Campaign Make integration:

If you are in the DACH region, you need an Optimizely Campaign API user who has the role bm - Webservice User Integration-Platform.

If you are outside the DACH region, you need an Optimizely Campaign API user who has the role epi - Webservice User Integration-Platform.

You have the login credentials for this API user.

You can log in to Optimizely Campaign with another user account (not strictly required but highly recommended for testing your scenarios).

You have a user account on make.com.

The login credentials of the API user will be used by Make to communicate with Optimizely Campaign. If you are in the DACH region, the Optimizely support will help you create a Campaign API user with the required role. If you are outside of the DACH region, you can do this via the self-service feature. In case of problems, please contact support.

With many mailbox providers, you can use email subaddressing to create such a user quickly, e. g. if your address is [email protected], you can create the user [email protected] as an new user in Optimizely Campaign. While the users are different, email messages for both addresses will arrive in your inbox for [email protected].

Setting up a connection

Context: Actions and polling-based triggers related to Optimizely Campaign require you to select or create a connection between Make and Campaign. Prerequisites: You are logged in in Make and see the scenario editor.

Add or select a module that requires a connection . → The properties of the new module are displayed.

Next to the field Connection, click Add. → The properties of the new connection are displayed.

Enter a name for the connection.

Enter the email and password of the API user.

Enter the Client ID (see the page API Overview in Campaign)

Click Save.

Triggers and Actions

Overview

When adding a module to a Make scenario, you can add triggers and events to control what will happen and when it will happen. Following triggers are provided for Optimizely Campaign:

Watch Bounces

Watch Recipients

Watch Spam Complaints

Watch Unsubscribes

Following actions are provided for Optimizely Campaign:

Create a Recipient

Make an API call

Send Transactional Message

Update a Recipient

To automate a process involving Optimizely Campaign and another application, create a scenario that combines a trigger or event from Optimizely Campaign with a trigger or event from the other application.

The trigger Watch Bounces

This trigger is activated when a bounce is registered in the Campaign client from the respective connection. It uses webhooks, so it triggers instantly when a bounce is registered. The trigger provides subsequent actions with the data that are available for bounce webhooks, see Webhooks.

The trigger Watch Recipients

This trigger is activated when a new recipient is created in a specific recipient list. It uses polling, so the intervals for checking for new recipients have to be configured. It has following options:

Connection (required): Select or create a connection to Optimizely Campaign.

Limit (required): Set the maximum number of results to be worked with during one execution.

Recipient List ID (required): Select the recipient list that is monitored by the trigger.

Recipient List attributes: Select one or more fields from the selected recipient list. The values of selected fields can then be used in subsequent actions.

Include Opt-in Data: Specify whether the opt-in data fields should be requested. Only applicable for opt-in lists.

The trigger Watch Spam complaints

This trigger is activated when a spam complaint is registered in the Campaign client from the respective connection. It uses webhooks, so it triggers instantly when a spam complaint is registered. The trigger provides subsequent actions with the data that are available for spam complaint webhooks, see Webhooks.

The trigger Watch Unsubscribes

This trigger is activated when an unsubscribe is registered in the Campaign client from the respective connection. It uses webhooks, so it triggers instantly when an unsubscribe is registered. The trigger provides subsequent actions with the data that are available for unsubscribe webhooks, see Webhooks.

The action Create a Recipient

This action serves to create a new recipient in Campaign. It has following options:

Connection (required): The Campaign client and the login data for your API user.

Recipient List ID: The recipient list you wish to edit.

Recipient ID: Usually the email address.

Adress: Email address of the recipient. Required if Recipient ID is not the email address.

Primary Key: The primary key of the selected recipient list. Make sure to select the correct one.

Recipient Data: A set of fields that are available in the selected recipient list.

Opt-in process ID: Select an opt-in process appropriate for adding recipients to your list.

Return Opt-in Mail ID: Retrieve the mail ID for an opt-in process of type double or confirmed and provide this ID for subsequent modules in the scenario.

The action Make an API Call

This action can send an API call to Optimizely Campaign, allowing you to leverage all features of Campaign's APIs in a Make scenario. Configure it according to the endpoint design of the API that you are adressing.

The action Send Transactional Message

This action serves to send a transactional message via Optimizely Campaign. It has following options:

Connection (required): The Campaign client and the login data for your API user.

Transactional Mail (required): The transactional campaign you wish to use for sending messages.

Recipient List ID (required): The recipient list that the transactional campaign shall use.

RecipientID (required): ID of the transactional message’s recipient. This must be valid as a primary key in the recipient list (usually an email address).

Primary Key (required): The primary key of the selected recipient list. Make sure to select the correct one.

Recipient Data: A set of fields that are available in the selected recipient list.

The action Update a Recipient

This aktion is similar to Create a Recipient, but serves to edit a recipient, that already exists. It has following options:

Connection (required): The Campaign client and the login data for your API user.

Recipient List ID (required): The recipient list you wish to edit.

Recipient ID: The ID of the recipient you want to update, usually the email address.

Primary Key: The primary key of the selected recipient list. Make sure to select the correct one.

Recipient Data: A set of fields that are available in the selected recipient list.

Mode: This is for chosing how to edit fields: Set overwrites existing field values; Prepend puts new content at the beginning of the existing field value; Append puts it at the end.