The Optimizely Campaign Zapier integration
Purpose
Zapier is an online automation tool that connects your apps and services. Please refer to the Zapier user documentation for learning about Zapier. The page Learn Key Concepts of Zapier provides a good starting point. Here, the focus is on using the Optimizely Campaign integration once you know the basics of Zapier.
The Zapier integration for Optimizely Campaign provides two types of objects:
- triggers that can be used to start zaps based on events in Optimizely Campaign,
- actions in Optimizely Campaign that can be used in a zap.
Video overview
Requirements
Following conditions are required for using the Optimizely Campaign Zapier integration:
- If you are in the DACH region, you need an Optimizely Campaign API user whose name contains “zapier” and who has the role bm - Webservice User Integration-Platform.
- If you are outside the DACH region, you need an Optimizely Campaign API user whose name contains “zapier” and 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 zaps).
- You have a user account on zapier.com.
- On zapier.com, you have access to the Optimizely Campaign Zapier integration.
The login credentials of the user with the bm/epi - Webservice User Zapier role will be used by the Zapier integration to communicate with Optimizely Campaign. If you are in the DACH region, the Optimizely support can help you create a user with this role in Optimizely Campaign. If you are outside of the DACH region, you can do this via the self-service feature. In case of problems, please contact support.
You can use email subaddressing to create such a 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 accounts will arrive in your inbox for [email protected].
Triggers and events
Overview
The Optimizely Campaign Zapier integration provides triggers and events for creating zaps. Triggers are occurences that can start a zap. Following triggers are provided by the Optimizely Campaign Zapier integration:
- GetRecipients: Triggers when a new recipient is found in a specific recipient list in Optimizely Campaign.
Actions are operations in Optimizely Campaign which can used in a zap. Following events are provided:
- Create a Recipient
- Update a Recipient
- Send Transactional Message
To automate a process involving Optimizely Campaign and another application, create a zap that combines a trigger or event from the Optimizely Campaign integration with a trigger or event from the other application.
The trigger GetRecipients
This trigger serves to start a zap when a new recipient is created. The trigger has the following options:
- Select a RecipientList (required): Here, you must select the recipient list that is monitored by the trigger. Only new recipients in the selected list will activate the trigger.
- Select required fields: Here, you can select one or more fields from the selected recipient list. The values of selected fields will be available for configuring the action performed by the zap if this is supported by the selected action.
The event Create a Recipient
This event serves to create a new recipient in Optimizely Campaign. The event has the following options:
- Select the RecipientID (required): Define the recipient’s ID in Optimizely Campaign. This must be valid as a primary key in the recipient list (usually an email address). Select a field value provided by the selected trigger to create multiple recipients with multiple runs of the same zap.
- Select a RecipientList (required): Select the recipient list that the new recipient will be added to.
- Trigger an Opt-In process: Decide if an opt-in process shall be started for the new recipient. If yes, select an opt-in process.
- Select Optimizely Campaign fields: Select the fields to which the zap shall write data. For each selected field you can either define a field value provided by the selected trigger or a fixed value.
The event Update a Recipient
This event serves to update an existing recipient in Optimizely Campaign. The event has the following options:
- Select the RecipientID (required): Define the recipient’s ID in Optimizely Campaign. Select a field value provided by the selected trigger to update multiple recipients with multiple runs of the same zap.
- Select a RecipientList (required): Select the recipient list that contains the recipient.
- Select Optimizely Campaign fields: Select the fields which the zap shall update. For each selected field you can either define a field value provided by the selected trigger or a fixed value.
The event Send Transactional Message
This event serves to send a transactional message via Optimizely Campaign. The event has the following options:
- Select the RecipientID (required): Define the ID of the transactional message’s recipient. This must be valid as a primary key in the recipient list (usually an email address). Select a field value provided by the selected trigger to address multiple recipients with multiple runs of the same zap.
- Select a Transactional Message (required): Select an existing message draft from a transactional campaign.
- Select a Transactional Recipient List (required): Select a transactional recipient list. Sending will only work with a transactional list!
- Select Optimizely Campaign fields: Select fields from the recipient list that you want to write data to.
Zap creation
Creating a zap triggered by Optimizely Campaign
Context: Triggers provided by the Optimizely Campaign Zapier integration can start a zap. Prerequisites: The general requirements for using the Optimizely Campaign Zapier integration are fulfilled (see Requirements).
- On zapier.com, open the page Zaps.
- Click + Create and in the pick list, select New Zap. → The zap editor is displayed.
- In the section Trigger, find the entry Optimizely Campaign. If necessary, enter “Optimizely Campaign” in the search field.
- Click on Optimizely Campaign. → The menu Trigger for events from Optimizely Campaign is displayed.
- In the pick list Event, select the desired trigger.
- Click Continue. → The section Choose Account is displayed.
- Click the pick list Choose an account...
- If the Optimizely Campaign user account with the bm/epi - Webservice User Zapier role is displayed, click it. → The account is selected for connecting to Optimizely Campaign. If the Optimizely Campaign user account with the bm/epi - Webservice User Zapier role is not displayed, click + Connect a new account. In the pop-up window, enter the credentials and click Yes, continue. → The newly entered account is selected for connecting to Optimizely Campaign.
- Click Continue. → The section Set up Trigger is displayed.
- Configure the trigger-specific settings. (See Triggers and actions)
- Click Continue. → The section Test Trigger is displayed.
- Click Test Trigger. → The newest occurences that match the trigger are displayed.
- Click Continue. → The menu Action is displayed.
- Click on the desired application. If necessary, use the search field. → The section Choose app and event is displayed.
- Select the desired action and configure it.
- Click Continue. → The section Test action is displayed.
- Click on Test action and check if you get the expected results.
- If your zap works as expected, click on Publish Zap and confirm the prompt. → The new zap will be triggered when the trigger is activated by Optimizely Campaign.
Creating a zap for controlling Optimizely Campaign
Context: Any trigger available in Zapier can trigger an action provided by the Optimizely Campaign Zapier integration. Prerequisites: The general requirements for using the Optimizely Campaign Zapier integration are fulfilled (see Requirements).
- On zapier.com, open the page Zaps.
- Click + Create and in the pick list, select New Zap. → The zap editor is displayed.
- In the section Trigger, select the desired app. If necessary, use the search field. → The menu Trigger is displayed.
- In the pick list Event, select the desired trigger and configure it.
- Click Continue. → The section Test Trigger is displayed.
- Click Test Trigger. → The newest occurences that match the trigger are displayed.
- Click Continue. → The menu Action is displayed.
- Find the entry Optimizely Campaign. If necessary, enter “Optimizely Campaign” in the search field.
- Click on Optimizely Campaign. → The menu Action for actions in Optimizely Campaign is displayed.
- In the pick list Event, select the desired action.
- Click Continue. → The section Choose Account is displayed.
- Click the pick list Choose an account...
- If the Optimizely Campaign user account with the bm/epi - Webservice User Zapier role is displayed, click it. → The stored account is selected for connecting to Optimizely Campaign. If the desired account is not displayed, click + Connect a new account. In the pop-up window, enter the credentials for the the Optimizely Campaign user with the bm/epi - Webservice User Zapier role and click Yes, continue. → The newly entered account is selected for connecting to Optimizely Campaign.
- Configure the action-specific settings. (See Triggers and actions)
- Click Continue → The section Test action is displayed.
- Click on Test action and check if you get the expected results.
- If your zap works as expected, click on Publish Zap and confirm the prompt. → The new zap will start the configured action in Optimizely Campaign when the configured trigger becomes active.