Starts a workflow for each contact in an Alchemer contact list on the date you specify.
You will need these items to configure the Contact List initiator:
- An Alchemer API key
- A contact list setup in Alchemer
- A date in the contact list for when the workflow should start for that contact (typically a custom field)
- A field in the contact list than can be updated with the result of the initiator (optional)
As a best practice, we don't recommend using the contact list initiator with very large contact lists.
This initiator checks the contact list and starts the workflow for the appropriate contacts each day. This initiator also makes all of the contact list fields available in your workflow as merge codes.
For example, let's say you have a contact list for new employees. After an employee is hired, just add the employee to the contact list with their start date. The initiator checks the contact list each day and starts for the workflow for the new employees that have a start date of that day.
Follow these steps to use the Contact List initiator:
1. When selecting an initiator, click "Alchemer".
2. Select "Contact list initiator".
3. Click "Next" on the initiator overview screen.
4. Click "New authentication". Them name your authentication and provide your Alchemer API Key and Secret.
Optional: Select your Alchemer API region.
This initiator uses the Alchemer API to pull contact lists.
For more information on finding your Alchemer API credentials, go here.
For more information on scoping/restricting API access, go here.
5. Select the contact list you want to use for this workflow. Any contact lists available to you will be available in the dropdown. If you are not seeing any contact lists, you will need to create one.
All of the contact and contact list fields for the chosen contact lists will be available as merge codes in the workflow.
6. Optional: Select a field in the contact list that will be updated with information about the Workflow run when the Workflow is started.
Here is an example of what the field will be updated with: Workflow 664e19b997f58 started at 2024-05-30T16:44:00.943Z
At this time you cannot update custom fields. We recommend using the URL field, title field, or any other contact field not used in your contact list.
7. Select the field that contains the date the should begin.
You can use custom fields to enter the time. You can learn more about custom fields here.
Date Field Information and Requirements:
- For the field, Alchemer can accept a variety of time formats including:
- ISO 8601 time stamp. Ex: 2024-09-27 18:00:00.000
- Month, day, year. Ex: July, 2, 2034
- MM/DD/YYYY. Ex;
- If timezone is not specified, Alchemer will assume UTC
8. Set when you would like this initiator to start running and set an end date after which this initiator should no longer run.
The initiator ones runs once per day starting at the date and time you set below. The timezones here are your local timezone (the timezone set in your browser).
9. Click "Save" to complete setup.
10. Use the contact list fields in your workflow as merge codes. For example, set the email address and customize the survey invite message.
If you change the fields in your contact list, you will need to go through the steps above again
