Estimated reading time: 25 min
What will start your automation…
A connection to your Mailchimp account is needed so we can sync it with our platform.
Refer to Mailchimp – connection.
Refer to Mailchimp – connection.
Trigger List and Settings Copy Link
Keep in mind that, we have combined Mailchimp Triggers with Mailchimp Transactional Triggers (formerly Mandrill).
You can distinguish between different Trigger types by their color. Triggers associated with Mailchimp Transactional will have a yellow Mailchimp logo. To use these Mailchimp Transactional Triggers, you must first establish a connection to your Mailchimp Transactional Email. See how to create a connection here.
You can distinguish between different Trigger types by their color. Triggers associated with Mailchimp Transactional will have a yellow Mailchimp logo. To use these Mailchimp Transactional Triggers, you must first establish a connection to your Mailchimp Transactional Email. See how to create a connection here.
Recurrence rule or scheduler settings Copy Link
Run Once Tab: This tab allows you to schedule a Flow to execute a single time at a specific date and time. This is ideal for one-time operations such as data syncs, cleanups, or initial configuration steps. After execution, the schedule will be automatically cleared unless rescheduled manually.
Run Tab: This tab is used to set up repeating schedules:
- Repeat feature: This dropdown determines how long the automation will continue repeating based on the selected frequency (Minutely or Hourly). You can choose from:
- Repeat Forever
- The automation will continue to run indefinitely at the defined interval (e.g. every 15 minutes).
- No end condition is specified.
- Repeat for (x) Times
- You set a specific number of repetitions.
- Requires the field Number (x) of Repeat Times to be filled (e.g. 10 times).
- Repeat Between Start & End Dates
- The automation will run only within a defined date range.
- Additional fields will appear to select start and end dates.
- Useful for limited-time schedules like campaigns or batch jobs.
- Repeat Forever
- Daily at Multiple Times: Sets the Flow to run several times per day based on a minutely or hourly interval.
- Daily: This allows a Flow to run x times per day at a specific time.
- Weekly: This allows you to run a Flow weekly by selecting the days and time.
- Monthly: This will monitor your Trigger every month on a defined date and hour.
- Yearly: This will monitor your Trigger on a specific date and hour every year.
- Specific dates: This will start your Trigger on specific dates and time.
For more details, see Wiresk Scheduler – The Fundamentals.
Get sample with the”Use” button Copy Link
After you’ve configured your Trigger parameters, select the “Use” button to fetch a live sample of data from the Trigger.
What it does:
- Extracts real data based on your Trigger setup
- Validates your parameters by showing if they match existing records
- Prepares data for field mapping – the sample helps you map your Trigger output to your Method parameters in the Flow. Refer to FIELD MAPPING documentation.
Think of it as a preview step: it makes sure your Trigger is working and gives you real data to work with when setting up the rest of your flow.
Scheduled Triggers: Copy Link
These Triggers will start your Flow automatically at a specific time or intervals instead of being triggered by events like Webhooks.
Mailchimp Triggers Copy Link
Search Merge Fields Copy Link
Get a list of all merge fields for an audience.
Configuration Table:
| Name* | Search Merge Fields |
| Connection* | Select your connection or create one. |
| Time out | You can additionally set the Trigger duration to limit the information processed per execution to optimize performance and resource usage. |
| Recurrence rule/scheduler* | Set up your recurrence rule. |
| Parameters | |
| Audience/List ID* | Select the Audience from a dynamic list. |
| Field Type: | Select the field type from a dynamic list. |
| Text | A string, truncated to 255 bytes. |
| Number | Any number |
| Phone | A string representing a phone number. |
| Date | A string in one of the following formats: YYYY-MM-DD |
| Url | A string, subject to URL validation. |
| ImageUrl | A string representing an image asset; the URL must be valid and reachable. |
| Radio | A string that matches one of the configured radio button options for the field. |
| Dropdown | A string that matches one of the configured drop-down options for the field. |
| Birthday | A string in the format MM/DD. |
| Zip | A string representing a 5-digit ZIP code. |
| Field Required | True – False |
| Limit | Set the limit for the number of records retrieved. If not specified, it will retrieve the number of records defined by the API limit. |
| Preview Data | Preview the retrieved data. In specific Trigger instances, data can only be previewed when it is available for retrieval. If no event occurs from the Trigger, a message “No data available” will be displayed. |
(*) required field
⚠️ Reminder: Click “Use” to validate your Trigger with sample data before saving.
Mapping Table from this Trigger (use this table to Map your Methods “Input” fields>Input tab>uncheck “Show recommended” to see all fields).
| Field | Description | Value Samples |
|---|---|---|
merge_id | Unique identifier for the merge field. | 3 |
tag | Merge field tag used in campaigns. | ADDRESS |
name | Name of the merge field. | Address |
type | Data type of the merge field. | address |
required | Indicates if the field is mandatory. | false |
default_value | Default value for the field. | |
public | Indicates if the field is visible to subscribers. | false |
display_order | Position of the field in the list’s field order. | 4 |
options.default_country | Default country ID for the address field. | 164 |
help_text | Help text for the field, displayed to users. | Sample text |
list_id | ID of the list to which this field belongs. | d39dbd327b |
List Members Tags Copy Link
Get the tags on a list member/contact.
Configuration Table:
| Name* | List Members Tags |
| Connection* | Select your connection or create one. |
| Time out | You can additionally set the Trigger duration to limit the information processed per execution to optimize performance and resource usage. |
| Recurrence rule/scheduler* | Set up your recurrence rule. |
| Parameters | |
| Audience/List ID* | Select the Audience from a dynamic list. |
| Email* | email address of the member/contact |
| Preview Data | Preview the retrieved data. In specific Trigger instances, data can only be previewed when it is available for retrieval. If no event occurs from the Trigger, a message “No data available” will be displayed. |
(*) required field
⚠️ Reminder: Click “Use” to validate your Trigger with sample data before saving.
Mapping Table from this Trigger (use this table to Map your Methods “Input” fields>Input tab>uncheck “Show recommended” to see all fields).
| Field | Type | Description | Value Sample |
|---|---|---|---|
id | integer | The unique id for the tag. | 2989676 |
name | string | The name of the tag. | Static Segment 01 |
date_added | string | The date and time the tag was added in ISO 8601 format. | 2023-12-20T04:33:39+00:00 |
List Contacts & Members in Segments Copy Link
Get information about members in a saved segment.
Configuration Table:
| Name* | List Members in Segment |
| Connection* | Select your connection or create one. |
| Time out | You can additionally set the Trigger duration to limit the information processed per execution to optimize performance and resource usage. |
| Recurrence rule/scheduler* | Set up your recurrence rule. |
| Parameters | |
| Audience/list ID* | Select the Audience from a dynamic list. |
| Segment or Tag ID* | Select the Segment from a dynamic list. |
| include cleaned members | Cleaned members refer to email addresses that have been permanently removed from your audience due to repeated hard bounces or because they were marked as invalid. Possible choice: True or False |
| Include transactional members | Include Members from Transactional email. Possible choice: True or False |
| Include unsubscribe members | Include unsubscribe members Possible choice: True or False |
| Limit | Set the limit for the number of records retrieved. Default value is 10. Maximum value is 1000. |
| Preview Data | Preview the retrieved data. In specific Trigger instances, data can only be previewed when it is available for retrieval. If no event occurs from the Trigger, a message “No data available” will be displayed. |
(*) required field
⚠️ Reminder: Click “Use” to validate your Trigger with sample data before saving.
Mapping Table from this Trigger (use this table to Map your Methods “Input” fields>Input tab>uncheck “Show recommended” to see all fields).
| Field | Description | Value Sample |
|---|---|---|
id | The unique identifier for the member. | 2c05cd15655628d84899e0d410c727a3 |
email_address | The email address of the member. | wiresktest@gmail.com |
full_name | The full name of the member. | Wiresk Developer |
unique_email_id | A unique identifier for the email address. | ef8d43a3ec |
email_type | The format for the email (html or text). | html |
status | The current subscription status of the member. | subscribed |
merge_fields | Custom fields for the member profile (e.g., name, address). | { ... } |
merge_fields.FNAME | First name of the member. | Wiresk |
merge_fields.LNAME | Last name of the member. | Developer |
merge_fields.ADDRESS | Address details of the member. | { ... } |
merge_fields.ADDRESS.addr1 | First line of the address. | S.J , K, demo, country name |
merge_fields.ADDRESS.addr2 | Second line of the address. | S.J, K, demo, country name |
merge_fields.ADDRESS.city | City of the address. | city sample |
merge_fields.ADDRESS.state | State of the address. | state sample |
merge_fields.ADDRESS.zip | Postal/ZIP code of the address. | 1233 |
merge_fields.ADDRESS.country | Country code of the address. | sample |
merge_fields.PHONE | Phone number (if provided). | "" |
merge_fields.BIRTHDAY | Member’s birthday. | "" |
stats | Email engagement statistics. | { ... } |
stats.avg_open_rate | Average email open rate for this member. | 0 |
stats.avg_click_rate | Average click rate for this member. | 0 |
ip_signup | IP address when the member signed up. | "" |
timestamp_signup | Timestamp of when the member signed up. | "" |
ip_opt | IP address when the member opted in. | 96.9.89.249 |
timestamp_opt | Timestamp of when the member opted in. | 2023-11-21T06:38:10+00:00 |
member_rating | Member rating for engagement, from 1 to 5. | 2 |
last_changed | The last time this member’s data was modified. | 2024-12-17T03:10:08+00:00 |
language | The preferred language of the member. | "" |
vip | Indicates if the member is marked as VIP. | false |
email_client | The email client used by the member (if available). | "" |
location | Location information of the member. | { ... } |
location.latitude | Latitude value of the member’s location. | 0 |
location.longitude | Longitude value of the member’s location. | 0 |
location.gmtoff | GMT offset of the location. | 0 |
location.dstoff | Daylight savings offset. | 0 |
location.country_code | The country code of the location. | "" |
location.timezone | Timezone of the location. | "" |
last_note | Details of the most recent note for the member. | { ... } |
last_note.note_id | The unique ID for the note. | 40266 |
last_note.created_at | Timestamp of when the note was created. | 2023-12-20T04:41:37+00:00 |
last_note.created_by | The ID of the creator of the note. | 215744674 |
last_note.note | Content of the note. | Do not delete. Used for test class |
list_id | The unique identifier for the Mailchimp list this member belongs to. | 92aeb8a4e9 |
_links | Related API endpoints for this member. | [ ... ] |
_links.rel | The relationship type of the API link. | self, update, delete, activity |
_links.href | The endpoint URL for the related resource. | https://us21.api.mailchimp.com/3.0/... |
_links.method | The HTTP method to interact with the link (e.g., GET, POST, PATCH, DELETE). | GET |
_links.targetSchema | The schema URL for the target resource. | https://us21.api.mailchimp.com/schema/... |
List’s Activities Copy Link
Retrieve daily aggregated activity stats for a specific list for the past 180 days. Exclude activity related to AutoResponders and Automations.
Configuration Table:
| Name* | List’s Activities |
| Connection* | Select your connection or create one. |
| Time out | You can additionally set the Trigger duration to limit the information processed per execution to optimize performance and resource usage. |
| Recurrence rule/scheduler* | Set up your recurrence rule. |
| Parameters | |
| Audience/List ID* | Select the Audience from a dynamic list. |
| Preview Data | Preview the retrieved data. In specific Trigger instances, data can only be previewed when it is available for retrieval. If no event occurs from the Trigger, a message “No data available” will be displayed. |
(*) required field
⚠️ Reminder: Click “Use” to validate your Trigger with sample data before saving.
Mapping Table from this Trigger (use this table to Map your Methods “Input” fields>Input tab>uncheck “Show recommended” to see all fields).
| Field | Type | Description | Value Sample |
|---|---|---|---|
day | string | The date for the activity summary. | 2023-12-12 |
emails_sent | integer | The total number of emails sent on the date for the activity summary. | 0 |
unique_opens | integer | The number of unique opens. | 0 |
recipient_clicks | integer | The number of clicks. | 0 |
hard_bounce | integer | The number of hard bounces. | 0 |
soft_bounce | integer | The number of soft bounces. | 0 |
subs | integer | The number of subscribes. | 0 |
unsubs | integer | The number of unsubscribes. | 0 |
other_adds | integer | The number of subscribers who may have been added outside of the double opt-in process, such as imports or API activity. | 0 |
other_removes | integer | The number of subscribers who may have been removed outside of unsubscribing or reporting an email as spam (for example, deleted subscribers). | 0 |
Search Subscriber (contacts & Members) Copy Link
Search for list members. This search can be restricted to a specific list, or can be used to search across all lists in an account.
Configuration Table:
| Name* | Search Subscriber |
| Connection* | Select your connection or create one. |
| Time out | You can additionally set the Trigger duration to limit the information processed per execution to optimize performance and resource usage. |
| Recurrence rule/scheduler* | Set up your recurrence rule. |
| Parameters | |
| Audience/list ID* | Select the Audience from a dynamic list. |
| Search Query* | Find contacts by entering their email address or searching by first or last name. |
| Preview Data | Preview the retrieved data. In specific Trigger instances, data can only be previewed when it is available for retrieval. If no event occurs from the Trigger, a message “No data available” will be displayed. |
(*) required field
⚠️ Reminder: Click “Use” to validate your Trigger with sample data before saving.
Mapping Table from this Trigger (use this table to Map your Methods “Input” fields>Input tab>uncheck “Show recommended” to see all fields).
| Field | Type | Description | Value Sample |
|---|---|---|---|
id | string | The MD5 hash of the lowercase version of the list member’s email address. | 2c05cd15655628d84899e0d410c727a3 |
email_address | string | Email address for a subscriber. | wiresktest@gmail.com |
unique_email_id | string | An identifier for the address across all of Mailchimp. | ef8d43a3ec |
contact_id | string | Contact ID agnostic of email address inclusion. | 316a9e6122b7de1ab2f5ce372103a1c8 |
full_name | string | The contact’s full name. | Wiresk Developer |
web_id | integer | The ID used in the Mailchimp web application. | 286932198 |
email_type | string | Type of email this member asked to get (“html” or “text”). | html |
status | string | Subscriber’s current status. Possible values: "subscribed", "unsubscribed", "cleaned", "pending", "transactional", or "archived". | subscribed |
unsubscribe_reason | string | A subscriber’s reason for unsubscribing. | sample |
consents_to_one_to_one_messaging | boolean | Indicates whether a contact consents to 1:1 messaging. | true |
sms_phone_number | string | SMS phone number of the subscriber. | |
merge_fields.FNAME | string | First name of the subscriber. | Wiresk |
merge_fields.LNAME | string | Last name of the subscriber. | Developer |
merge_fields.ADDRESS.addr1 | string | Address line 1. | S.J , K, demo, sample |
merge_fields.ADDRESS.addr2 | string | Address line 2. | S.J, K, demo, sample |
merge_fields.ADDRESS.city | string | City of the address. | sample |
merge_fields.ADDRESS.state | string | State of the address. | sample |
merge_fields.ADDRESS.zip | string | ZIP code of the address. | 1233 |
merge_fields.ADDRESS.country | string | Country of the address. | FR |
stats.avg_open_rate | number | A subscriber’s average open rate. | 0 |
stats.avg_click_rate | number | A subscriber’s average clickthrough rate. | 0 |
ip_opt | string | The IP address the subscriber used to confirm their opt-in status. | 96.9.89.249 |
timestamp_opt | string | The date and time the subscriber confirmed their opt-in status in ISO 8601. | 2023-11-21T06:38:10+00:00 |
member_rating | integer | Star rating for this member, between 1 and 5. | 2 |
last_changed | string | The date and time the member’s info was last changed in ISO 8601 format. | 2024-12-17T03:10:08+00:00 |
vip | boolean | VIP status for subscriber. | false |
location.latitude | number | The location latitude. | 0 |
location.longitude | number | The location longitude. | 0 |
location.country_code | string | The unique code for the location country. | |
location.timezone | string | The timezone for the location. | |
last_note.note_id | integer | The note ID. | 40266 |
last_note.created_at | string | The date and time the note was created in ISO 8601 format. | 2023-12-20T04:41:37+00:00 |
last_note.note | string | The content of the note. | Do not delete. Used for test class |
source | string | The source from which the subscriber was added to this list. | Admin Add |
tags_count | integer | The number of tags applied to this member. | 3 |
tags[0].id | integer | The tag ID of the first tag. | 2989705 |
tags[0].name | string | The name of the first tag. | Wiresk Dev |
tags[1].id | integer | The tag ID of the second tag. | 2989706 |
tags[1].name | string | The name of the second tag. | Wiresk QA |
tags[2].id | integer | The tag ID of the third tag. | 2989680 |
tags[2].name | string | The name of the third tag. | Static Segment test class 01 |
_links[0].rel | string | Describes the type of the first link. | self |
_links[0].href | string | Fully-qualified URL for the first link. | sample |
_links[0].method | string | HTTP method used for the first link. | GET |
Search Campaigns Copy Link
Search all campaigns for the specified query terms, search by title.
Configuration Table:
| Name* | Search Campaigns |
| Connection* | Select your connection or create one. |
| Time out | You can additionally set the Trigger duration to limit the information processed per execution to optimize performance and resource usage. |
| Recurrence rule/scheduler* | Set up your recurrence rule. |
| Parameters | |
| Search by Title* | Enter your search criteria to filter the results. |
| Limit | Set the limit for the number of records retrieved. If not specified, it will retrieve the number of records defined by the API limit. |
| Preview Data | Preview the retrieved data. In specific Trigger instances, data can only be previewed when it is available for retrieval. If no event occurs from the Trigger, a message “No data available” will be displayed. |
(*) required field
⚠️ Reminder: Click “Use” to validate your Trigger with sample data before saving.
Mapping Table from this Trigger (use this table to Map your Methods “Input” fields>Input tab>uncheck “Show recommended” to see all fields).
| Field | Description | Value Samples |
|---|---|---|
id | Unique identifier for the campaign. | 1524082d18 |
web_id | Mailchimp’s internal identifier for the campaign. | 6117934 |
type | Type of campaign. | regular |
create_time | Timestamp when the campaign was created. | 2024-11-29T03:13:42+00:00 |
archive_url | URL to the campaign’s archive. | Archive URL |
long_archive_url | Longer version of the archive URL. | Long Archive URL |
status | Current status of the campaign. | sent |
emails_sent | Number of emails successfully sent. | 3 |
send_time | Timestamp when the campaign was sent. | 2024-11-29T04:03:39+00:00 |
content_type | Type of content in the campaign. | multichannel |
needs_block_refresh | Indicates whether content blocks need to be refreshed. | false |
resendable | Indicates if the campaign is resendable. | false |
recipients.list_id | ID of the list used for the campaign. | d39dbd327b |
recipients.list_name | Name of the list used for the campaign. | wiresk |
recipients.recipient_count | Total number of recipients. | 3 |
settings.subject_line | Subject line of the email. | Untitled |
settings.title | Internal title for the campaign. | test template email |
settings.from_name | Name in the “From” field. | wiresk |
settings.reply_to | Reply-to email address. | username@wiresk.com |
settings.authenticate | Indicates if DKIM/SPF authentication is enabled. | true |
tracking.opens | Indicates if open tracking is enabled. | true |
tracking.html_clicks | Indicates if click tracking in HTML emails is enabled. | true |
tracking.text_clicks | Indicates if click tracking in plain-text emails is enabled. | false |
report_summary.opens | Total number of opens recorded. | 0 |
report_summary.unique_opens | Number of unique opens recorded. | 0 |
report_summary.clicks | Total number of clicks recorded. | 0 |
delivery_status.enabled | Indicates if delivery tracking is enabled. | false |
List Click Report Copy Link
Get information about clicks on specific links in your Mailchimp campaigns.
Configuration Table:
| Name* | List Click Report |
| Connection* | Select your connection or create one. |
| Time out | You can additionally set the Trigger duration to limit the information processed per execution to optimize performance and resource usage. |
| Recurrence rule/scheduler* | Set up your recurrence rule. |
| Parameters | |
| Campaign ID* | Select the Campaign or Map the Campaign ID form a step response like “List Campaigns” or “Get campaign”. |
| Limit | Set the limit for the number of records retrieved. Default value is 10. Maximum value is 1000. |
| Preview Data | Preview the retrieved data. In specific Trigger instances, data can only be previewed when it is available for retrieval. If no event occurs from the Trigger, a message “No data available” will be displayed. |
(*) required field
⚠️ Reminder: Click “Use” to validate your Trigger with sample data before saving.
Mapping Table from this Trigger (use this table to Map your Methods “Input” fields>Input tab>uncheck “Show recommended” to see all fields).
| Field | Type | Description | Value Sample |
|---|---|---|---|
id | string | The unique identifier for the resource. | 81786957ea |
url | string | URL of the Mailchimp knowledge base article. | URL sample |
total_clicks | integer | Total number of clicks. | 0 |
unique_clicks | integer | Number of unique clicks. | 0 |
click_percentage | integer | Percentage of clicks in relation to sends. | 1 |
unique_click_percentage | integer | Percentage of unique clicks in relation to sends. | 0 |
last_click | string | The date and time of the most recent click in ISO 8601 format. | Date-time sample |
_links[0].rel | string | Describes the type of the first link. | parent |
_links[0].href | string | Fully-qualified URL for the first link. | |
_links[0].method | string | HTTP method used for the first link. | GET |
_links[0].targetSchema | string | URL representing the schema that the response should conform to for GET requests. | |
Search Audience/List Copy Link
Get information about all lists in the account. Refer to the official Mailchimp documentation on Lists/Audiences.
Configuration Table:
| Name* | Search Audience/List |
| Connection* | Select your connection or create one. |
| Time out | You can additionally set the Trigger duration to limit the information processed per execution to optimize performance and resource usage. |
| Recurrence rule/scheduler* | Set up your recurrence rule. |
| Parameters | |
| Subscriber Email | Filter results to lists that include a specific subscriber’s email address. |
| Before Date Created | Restrict response to lists created before the set date. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00. |
| Since Date Created | Restrict results to lists created after the set date. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00. |
| Before Campaigns Last Sent | Restrict results to lists created before the last campaign send date. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00. |
| Since Campaigns Last Sent | Restrict results to lists created after the last campaign send date. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00. |
| Sort by | Ascending – Descending |
| Limit | Set the limit for the number of records retrieved. Default value is 10. Maximum value is 1000. |
| Preview Data | Preview the retrieved data. In specific Trigger instances, data can only be previewed when it is available for retrieval. If no event occurs from the Trigger, a message “No data available” will be displayed. |
(*) required field
⚠️ Reminder: Click “Use” to validate your Trigger with sample data before saving.
Mapping Table from this Trigger (use this table to Map your Methods “Input” fields>Input tab>uncheck “Show recommended” to see all fields).
| Field | Type | Description | Value |
|---|---|---|---|
id | string | A string that uniquely identifies this list. | 81786957ea |
web_id | integer | The ID used in the Mailchimp web application. View this list in your Mailchimp account at https://{dc}.admin.mailchimp.com/lists/members/?id={web_id}. | 13580871 |
name | string | The name of the list. | Member |
contact | object | Contact information displayed in campaign footers to comply with international spam laws. | – |
contact.company | string | The company name for the list. | Wiresk group |
contact.address1 | string | The street address for the list contact. | sample |
contact.address2 | string | The street address for the list contact. | sample |
contact.city | string | The city for the list contact. | sample |
contact.state | string | The state for the list contact. | sample |
contact.zip | string | The postal or zip code for the list contact. | sample |
contact.country | string | A two-character ISO3166 country code. Defaults to US if invalid. | sample |
contact.phone | string | The phone number for the list contact. | +00123456789 |
permission_reminder | string | The permission reminder for the list. | permission reminder |
use_archive_bar | boolean | Whether campaigns for this list use the Archive Bar in archives by default. | false |
campaign_defaults | object | Default values for campaigns created for this list. | – |
campaign_defaults.from_name | string | The default from name for campaigns sent to this list. | Name |
campaign_defaults.from_email | string | The default from email for campaigns sent to this list. | @mail.com |
campaign_defaults.subject | string | The default subject line for campaigns sent to this list. | Wiresk |
campaign_defaults.language | string | The default language for this list’s forms. | Wiresk |
notify_on_subscribe | string | The email address to send subscribe notifications to. | @mail.com |
notify_on_unsubscribe | string | The email address to send unsubscribe notifications to. | @mail.com |
date_created | string | The date and time that this list was created in ISO 8601 format. | 2023-11-20T07:47:51+00:00 |
list_rating | integer | An auto-generated activity score for the list (0-5). | 0 |
email_type_option | boolean | Whether the list supports multiple formats for emails. When set to true, subscribers can choose whether they want to receive HTML or plain-text emails. | true |
subscribe_url_short | string | Our URL shortened version of this list’s subscribe form. | sample |
subscribe_url_long | string | The full version of this list’s subscribe form (host will vary). | sample |
beamer_address | string | The list’s Email Beamer address. | sample |
visibility | string | Legacy – visibility settings are no longer used. Possible values: “pub” or “prv”. | prv |
double_optin | boolean | Whether or not to require the subscriber to confirm subscription via email. | false |
has_welcome | boolean | Whether or not this list has a welcome automation connected. Welcome Automations: welcomeSeries, singleWelcome, emailFollowup. | false |
marketing_permissions | boolean | Whether or not the list has marketing permissions (e.g., GDPR) enabled. | false |
modules | string[] | Any list-specific modules installed for this list. | [] |
stats | object | Stats for the list. Many of these are cached for at least five minutes. | – |
stats.member_count | integer | The number of active members in the list. | 0 |
stats.unsubscribe_count | integer | The number of members who have unsubscribed from the list. | 0 |
stats.cleaned_count | integer | The number of members cleaned from the list. | 0 |
stats.member_count_since_send | integer | The number of active members in the list since the last campaign was sent. | 0 |
stats.unsubscribe_count_since_send | integer | The number of members who have unsubscribed since the last campaign was sent. | 0 |
stats.cleaned_count_since_send | integer | The number of members cleaned from the list since the last campaign was sent. | 0 |
stats.campaign_count | integer | The number of campaigns in any status that use this list. | 0 |
stats.campaign_last_sent | string | The date and time the last campaign was sent to this list in ISO 8601 format. This is updated when a campaign is sent to 10 or more recipients. | 2023-12-06T08:23:07+00:00 |
stats.merge_field_count | integer | The number of merge fields (audience fields) for this list (doesn’t include EMAIL). | 1 |
stats.avg_sub_rate | number | The average number of subscriptions per month for the list (not returned if we haven’t calculated it yet). | 1 |
stats.avg_unsub_rate | number | The average number of unsubscriptions per month for the list (not returned if we haven’t calculated it yet). | 1 |
stats.target_sub_rate | number | The target number of subscriptions per month for the list to keep it growing (not returned if we haven’t calculated it yet). | 1 |
stats.open_rate | number | The average open rate (a percentage represented as a number between 0 and 100) per campaign for the list (not returned if we haven’t calculated it yet). | 1 |
stats.click_rate | number | The average click rate (a percentage represented as a number between 0 and 100) per campaign for the list (not returned if we haven’t calculated it yet). | 1 |
stats.last_sub_date | string | The date and time of the last time someone subscribed to this list in ISO 8601 format. | 2023-12-06T08:23:07+00:00 |
stats.last_unsub_date | string | The date and time of the last time someone unsubscribed from this list in ISO 8601 format. | 2023-12-06T08:23:07+00:00 |
_links | object[] | A list of link types and descriptions for the API schema documents. | – |
_links.rel | string | As with an HTML ‘rel’ attribute, this describes the type of link. | parent |
_links.href | string | This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. | sample |
_links.method | string | The HTTP method that should be used when accessing the URL defined in ‘href’. Possible values: “GET”, “POST”, “PUT”, “PATCH”, “DELETE”, “OPTIONS”, or “HEAD”. | GET |
List Members’ Activities Copy Link
Get the last 50 events of a member’s activity on a specific list, including opens, clicks, and unsubscribes.
Configuration Table:
| Name* | List Members’ Activities |
| Connection* | Select your connection or create one. |
| Time out | You can additionally set the Trigger duration to limit the information processed per execution to optimize performance and resource usage. |
| Recurrence rule/scheduler* | Set up your recurrence rule. |
| Parameters | |
| Audience/List ID* | Select the audience from a dynamic list. |
| Email* | email address of the member/contact. |
| Action | List of actions Possible values: abuse, bounce, click, open, sent, unsub, or ecomm. |
| Preview Data | Select at least 1 action to return before using the preview data. In specific Trigger instances, data can only be previewed when it is available for retrieval. If no event occurs from the Trigger, a message “No data available” will be displayed. |
(*) required field
⚠️ Reminder: Click “Use” to validate your Trigger with sample data before saving.
Mapping Table from this Trigger (use this table to Map your Methods “Input” fields>Input tab>uncheck “Show recommended” to see all fields).
| Field | Type | Description | Value Sample |
|---|---|---|---|
action | string | The type of action recorded for the subscriber. | bounce |
timestamp | string | The date and time recorded for the action. | 2023-12-08T09:46:51+00:00 |
type | string | The type of campaign that was sent. | hard |
campaign_id | string | The web-based ID for the campaign. | 87b360a27f |
title | string | If set, the campaign’s title. | Campaign Wiresk |
Mailchimp Transactional Triggers Copy Link
List Sender Domains Copy Link
Returns the sender domains that have been added to your account.
Configuration Table:
| Name* | List Sender Domains |
| Connection* | Select your connection or create one. |
| Time out | You can additionally set the Trigger duration to limit the information processed per execution to optimize performance and resource usage. |
| Recurrence rule/scheduler* | Set up your recurrence rule. |
| Parameters | |
| Retrieve record by | Choose All Record to list all Sender Domains. If you select New Record, only new Sender Domaines added after the previous run of the Flow will be listed. |
| Preview Data | Preview the retrieved data. In specific Trigger instances, data can only be previewed when it is available for retrieval. If no event occurs from the Trigger, a message “No data available” will be displayed. |
(*) required field
⚠️ Reminder: Click “Use” to validate your Trigger with sample data before saving.
Mapping Table from this Trigger (use this table to Map your Methods “Input” fields>Input tab>uncheck “Show recommended” to see all fields).
| Field | Description | Value Sample |
|---|---|---|
domain | The domain name being verified. | string |
created_at | Timestamp when the domain was created in the system. | 2019-08-24T14:15:22Z |
last_tested_at | Timestamp when the domain was last tested for verification. | 2019-08-24T14:15:22Z |
spf | SPF (Sender Policy Framework) validation details. | { ... } |
spf.valid | Indicates whether SPF validation was successful (true or false). | true |
spf.valid_after | Timestamp indicating when SPF becomes valid. | 2019-08-24T14:15:22Z |
spf.error | Any error details related to SPF validation. | string |
dkim | DKIM (DomainKeys Identified Mail) validation details. | { ... } |
dkim.valid | Indicates whether DKIM validation was successful (true or false). | true |
dkim.valid_after | Timestamp indicating when DKIM becomes valid. | 2019-08-24T14:15:22Z |
dkim.error | Any error details related to DKIM validation. | string |
dkim2 | Secondary DKIM validation details (additional key validation). | { ... } |
dkim2.valid | Indicates whether secondary DKIM validation was successful. | true |
dkim2.valid_after | Timestamp indicating when secondary DKIM becomes valid. | 2019-08-24T14:15:22Z |
dkim2.error | Any error details related to secondary DKIM validation. | string |
dmarc | DMARC (Domain-based Message Authentication) validation details. | { ... } |
dmarc.valid | Indicates whether DMARC validation was successful (true or false). | true |
dmarc.error | Any error details related to DMARC validation. | string |
verified_at | Timestamp when the domain was verified successfully. | 2019-08-24T14:15:22Z |
valid_signing | Indicates whether the domain supports valid email signing (true or false). | true |
verify_txt_key | Verification TXT record key required for DNS verification. | string |
List SubAccounts Copy Link
Get the list of Subaccounts of your account, optionally filtered by a prefix search
Configuration Table:
| Name* | List SubAccounts |
| Connection* | Select your connection or create one. |
| Time out | You can additionally set the Trigger duration to limit the information processed per execution to optimize performance and resource usage. |
| Recurrence rule/scheduler* | Set up your recurrence rule. |
| Parameters | |
| Search | Optional prefix to filter the subaccounts’ ids and names. |
| Retrieve record by | Selecting “All Records” retrieve all existing records. Choosing “New Record” shows only records created since the last time the flow was executed. |
| Preview Data | Preview the retrieved data. In specific Trigger instances, data can only be previewed when it is available for retrieval. If no event occurs from the Trigger, a message “No data available” will be displayed. |
(*) required field
⚠️ Reminder: Click “Use” to validate your Trigger with sample data before saving.
Mapping Table from this Trigger (use this table to Map your Methods “Input” fields>Input tab>uncheck “Show recommended” to see all fields).
| Field | Description | Values Samples |
|---|---|---|
id | The unique identifier for the user or email account. | "Wiresk@gmail.com" |
name | The name associated with the user or email account. | "Wiresk@gmail.com" |
created_at | The timestamp when the user or account was created. | "2024-10-10 09:53:08.79119" |
status | The current status of the account. | "active" |
reputation | A numerical value representing the account’s reputation score. | 50 |
sent_weekly | The number of emails sent by the account in the last week. | 0 |
sent_monthly | The number of emails sent by the account in the last month. | 0 |
sent_total | The total number of emails sent by the account. | 0 |
List Scheduled Emails Copy Link
Use this Method to retrieve a list of scheduled emails.Without filtering for a specific recipient, this Method will return all scheduled emails for your account.
Configuration Table:
| Name* | List Scheduled Emails |
| Connection* | Select your connection or create one. |
| Time out | You can additionally set the Trigger duration to limit the information processed per execution to optimize performance and resource usage. |
| Recurrence rule/scheduler* | Set up your recurrence rule. |
| Parameters | |
| Recipient address | List the scheduled emails from this Recipient. |
| Retrieve record by | Selecting “All Records” retrieve all existing records. Choosing “New Record” shows only records created since the last time the flow was executed. |
| Preview Data | Preview the retrieved data. In specific Trigger instances, data can only be previewed when it is available for retrieval. If no event occurs from the Trigger, a message “No data available” will be displayed. |
(*) required field
⚠️ Reminder: Click “Use” to validate your Trigger with sample data before saving.
Mapping Table from this Trigger (use this table to Map your Methods “Input” fields>Input tab>uncheck “Show recommended” to see all fields).
| Field | Description | Value Samples |
|---|---|---|
created_at | Timestamp when the record was created. | 2024-10-10 09:53:08.79119 |
send_at | Scheduled time to send the email. | 2019-08-24T14:15:22Z |
subject | Subject of the email. | Hello Dear |
_id | Unique identifier for the email. | 434e696446d04179bd92813ee29c2e96 |
from_email | Sender’s email address. | user@example.com |
to | Recipient’s email address. | user@example.com |
List Metadata Copy Link
Get the list of custom metadata fields indexed for the account.
Configuration Table:
| Name* | List Metadata |
| Connection* | Select your connection or create one. |
| Time out | You can additionally set the Trigger duration to limit the information processed per execution to optimize performance and resource usage. |
| Recurrence rule/scheduler* | Set up your recurrence rule. |
| Parameters | |
| Retrieve Record by | Selecting “All Records” retrieve all existing records. Choosing “New Record” shows only records created since the last time the flow was executed. |
| Preview Data | Preview the retrieved data. In specific Trigger instances, data can only be previewed when it is available for retrieval. If no event occurs from the Trigger, a message “No data available” will be displayed. |
(*) required field
⚠️ Reminder: Click “Use” to validate your Trigger with sample data before saving.
Mapping Table from this Trigger (use this table to Map your Methods “Input” fields>Input tab>uncheck “Show recommended” to see all fields).
| Field | Description | Value Sample |
|---|---|---|
name | the unique identifier of the metadata field to update | "string" |
state | the current state of the metadata field Possible values: "active", "delete", or "index". | "active" |
view_template | Mustache template to control how the metadata is rendered in your activity log | "string" |
List all Tags History Copy Link
Return the recent emails sending history (hourly stats for the last 30 days) for all tags.
Configuration Table:
| Name* | List all Tags History |
| Connection* | Select your connection or create one. |
| Time out | You can additionally set the Trigger duration to limit the information processed per execution to optimize performance and resource usage. |
| Recurrence rule/scheduler* | Set up your recurrence rule. |
| Parameters | |
| Retrieve Record by | Selecting “All Records” retrieve all existing records. Choosing “New Record” shows only records created since the last time the flow was executed. |
| Preview Data | Preview the retrieved data. In specific Trigger instances, data can only be previewed when it is available for retrieval. If no event occurs from the Trigger, a message “No data available” will be displayed. |
(*) required field
⚠️ Reminder: Click “Use” to validate your Trigger with sample data before saving.
Mapping Table from this Trigger (use this table to Map your Methods “Input” fields>Input tab>uncheck “Show recommended” to see all fields).
| Field | Description | Value Sample |
|---|---|---|
time | The hour as a UTC date string in YYYY-MM-DD HH:MM:SS format. | "2019-08-24T14:15:22Z" |
sent | The number of emails that were sent during the hour. | 0 |
hard_bounces | The number of emails that hard bounced during the hour. | 0 |
soft_bounces | The number of emails that soft bounced during the hour. | 0 |
rejects | The number of emails that were rejected during the hour. | 0 |
complaints | The number of spam complaints received during the hour. | 0 |
unsubs | The number of unsubscribes received during the hour. | 0 |
opens | The number of emails opened during the hour. | 0 |
unique_opens | The number of unique opens generated by messages sent during the hour. | 0 |
clicks | The number of tracked URLs clicked during the hour. | 0 |
unique_clicks | The number of unique clicks generated by messages sent during the hour. | 0 |
Search Message by Date Copy Link
Search recently sent messages and optionally filter by date range, tags, senders, and API keys. If no date range is specified, results within the last 7 days are returned. This method may be called up to 20 times per minute.
Configuration Table:
| Name* | Search Message by Date |
| Connection* | Select your connection or create one. |
| Time out | You can additionally set the Trigger duration to limit the information processed per execution to optimize performance and resource usage. |
| Recurrence rule/scheduler* | Set up your recurrence rule. |
| Parameters | |
| Search | This field allows you to search for messages using specific keywords or phrases. |
| Start date | Set the beginning date of the search range. |
| End Date | Set the end date of the search range. |
| Tags[+Add] | You can filter messages by specific tags. You can add multiple tags by clicking the “Add” button. |
| Senders[+Add] | You can filter messages by the sender’s email address. You can add multiple senders by clicking the “Add” button. |
| API key[+Add] | You can specify an API key to narrow the search, this will return messages sent by ANY of the keys. |
| Limit | The maximum number of results to return, defaults is 100, 1000 is the maximum. |
| Retrieve Record by | Selecting “All Records” retrieve all existing records. Choosing “New Record” shows only records created since the last time the flow was executed. |
| Preview Data | Preview the retrieved data. In specific Trigger instances, data can only be previewed when it is available for retrieval. If no event occurs from the Trigger, a message “No data available” will be displayed. |
(*) required field
⚠️ Reminder: Click “Use” to validate your Trigger with sample data before saving.
Mapping Table from this Trigger (use this table to Map your Methods “Input” fields>Input tab>uncheck “Show recommended” to see all fields).
| Field | Description | Sample Value |
|---|---|---|
diag | Diagnostic message for the event. | "diag" |
email | The recipient email address. | "email@test.com" |
@version | Version identifier. | "1" |
smtp_events | List of SMTP-related events for the message. | [ ... ] |
smtp_events.ts | The Unix timestamp when the SMTP event occurred. | 0 |
smtp_events.type | The type of SMTP event. | "string" |
smtp_events.diag | Diagnostic message for the SMTP event. | "string" |
log_classification | Classification of the log (e.g., sensitive). | "sensitive" |
event | Original event payload in JSON string format. | {...} |
event.original | The raw payload of the original event. | "payload content" |
event.method | The HTTP method used to log the event. | "PUT" |
bgtools_code | The code returned by background tools. | 0 |
document_id | The unique document ID. | "31556930.434e696446d04179bd92813ee29c2e96" |
subaccount | The subaccount associated with this message. | "Subaccount@test.com" |
subject | The subject line of the message. | "Hello Dear" |
resends | List of resends related to this message. | null |
state | The sending state of the message. Possible values: "sent", "bounced", "rejected". | "rejected" |
tags | List of tags attached to the message. | [ ... ] |
tags.value | Value of a tag. | "Wiresk" |
reject | Details of why the message was rejected. | { ... } |
reject.reason | Reason why the message was rejected. | "unsigned" |
reject.last_event_at | Timestamp of the last event for the rejection. | null |
@timestamp | The timestamp of the log in ISO 8601 format. | "2024-10-22T03:57:43.854948231Z" |
ts | The Unix timestamp when the event occurred. | 1729569463 |
elasticsearch_index | The name of the Elasticsearch index storing this log. | "bounced-2024-10-22" |
_id | The unique identifier for this message. | "434e696446d04179bd92813ee29c2e96" |
sender | The email address of the sender. | "test@sender.com" |
template | The template name, if any, associated with the message. | sample name |
bounce_description | A description of the bounce type. | "general" |
clicks_detail | List of detailed click events for this message. | [ ... ] |
clicks_detail.ts | The Unix timestamp when the link was clicked. | 0 |
clicks_detail.url | The URL that was clicked. | "string" |
clicks_detail.ip | The IP address that generated the click. | "string" |
clicks_detail.location | The approximate location (region and country) of the click. | "string" |
clicks_detail.ua | The email client or browser data of the click event. | "string" |
opens | The total number of times this message has been opened. | 0 |
clicks | The total number of times links have been clicked in this message. | 0 |
List Templates Copy Link
Retrieve a list of all the templates available to this user.
Configuration Table:
| Name* | List Templates |
| Connection* | Select your connection or create one. |
| Time out | You can additionally set the Trigger duration to limit the information processed per execution to optimize performance and resource usage. |
| Recurrence rule/scheduler* | Set up your recurrence rule. |
| Parameters | |
| Label | Optional label to filter the templates. |
| Retrieve record by | Selecting “All Records” retrieve all existing records. Choosing “New Record” shows only records created since the last time the flow was executed. |
| Preview Data | Preview the retrieved data. In specific Trigger instances, data can only be previewed when it is available for retrieval. If no event occurs from the Trigger, a message “No data available” will be displayed. |
(*) required field
⚠️ Reminder: Click “Use” to validate your Trigger with sample data before saving.
Mapping Table from this Trigger (use this table to Map your Methods “Input” fields>Input tab>uncheck “Show recommended” to see all fields).
| Field | Description | Sample Value |
|---|---|---|
slug | Unique identifier or slug for the mail template. | "wiresk-dev-mail-template" |
name | Name of the mail template. | "Wiresk Dev Mail Template" |
code | the full HTML code of the template, with mc:edit attributes marking the editable elements – draft version | "<html>...<title>Verify Your Email</title>..." |
published_at | the date and time the template was last published as a UTC string in YYYY-MM-DD HH:MM:SS format, or null if it has not been published | "2024-10-21 04:45:35" |
created_at | the date and time the template was first created as a UTC string in YYYY-MM-DD HH:MM:SS format | "2024-10-21 04:41:07.90611" |
updated_at | the date and time the template was last modified as a UTC string in YYYY-MM-DD HH:MM:SS format | "2024-10-21 04:45:35.34298" |
draft_updated_at | Timestamp of the last update to the draft version. | "2024-10-21 04:43:45" |
publish_name | Name used when the template is published. | "Wiresk Dev Mail Template" |
labels | the list of labels applied to the template | [{"value": "Wiresk Dev Mail Template"}] |
labels.value | Tag value assigned. | "Wiresk Dev Mail Template" |
text | the default text part of messages sent with the template, if provided – draft version | test |
publish_text | the default text part of messages sent with the template, if provided | test |
subject | the subject line of the template, if provided – draft version | "Wiresk Dev Mail Template" |
publish_subject | the subject line of the template, if provided | "Wiresk Dev Mail Template" |
from_email | Sender’s email address for the draft version. | "demo@email.com" |
publish_from_email | Sender’s email address for the published version. | " |
from_name | Sender’s name for the draft version. | "Wiresk" |
publish_from_name | Sender’s name for the published version. | "Wiresk" |
is_broken_template | indicates if the template is malformed or corrupt | false |
List Denylisted Emails Copy Link
Access your list of emails that were rejected. You can search for specific emails if needed. Only shows current rejections by default. To see expired rejections, set ‘include_expired’ to ‘true’. Returns a maximum of 1000 results.
Configuration Table:
| Name* | List Denylisted Emails |
| Connection* | Select your connection or create one. |
| Time out | You can additionally set the Trigger duration to limit the information processed per execution to optimize performance and resource usage. |
| Recurrence rule/scheduler* | Set up your recurrence rule. |
| Parameters | |
| Optional email address to search by. | |
| Include Expired | Whether to include rejections that have already expired. possible values: True, False |
| Sub Accounts | Optional unique identifier for the subaccount to limit the denylist. |
| Retrieve Record by | Selecting “All Records” retrieve all existing records. Choosing “New Record” shows only records created since the last time the flow was executed. |
| Preview Data | Preview the retrieved data. In specific Trigger instances, data can only be previewed when it is available for retrieval. If no event occurs from the Trigger, a message “No data available” will be displayed. |
(*) required field
⚠️ Reminder: Click “Use” to validate your Trigger with sample data before saving.
Mapping Table from this Trigger (use this table to Map your Methods “Input” fields>Input tab>uncheck “Show recommended” to see all fields).
| Field | Type | Description | Value Sample |
|---|---|---|---|
email | string | The email that is blocked. | user@example.com |
reason | string | The type of event (hard-bounce, soft-bounce, spam, unsub, custom) that caused this rejection. | unsigned |
detail | string | Extended details about the event, such as the SMTP diagnostic for bounces or the comment for manually-created rejections. | string |
created_at | string | When the email was added to the denylist. | 2019-08-24T14:15:22Z |
last_event_at | string | The timestamp of the most recent event that either created or renewed this rejection. | 2019-08-24T14:15:22Z |
expires_at | string | When the denylist entry will expire (this may be in the past). | 2019-08-24T14:15:22Z |
expired | boolean | Whether the denylist entry has expired. | true |
sender | object | The sender that this denylist entry applies to, or null if none. | See below |
sender.address | string | The sender’s email address. | user@example.com |
sender.created_at | string | The date and time that the sender was first seen by Mandrill as a UTC date string in YYYY-MM-DD HH:MM:SS format. | 2019-08-24T14:15:22Z |
sender.sent | integer | The total number of messages sent by this sender. | 0 |
sender.hard_bounces | integer | The total number of hard bounces by messages by this sender. | 0 |
sender.soft_bounces | integer | The total number of soft bounces by messages by this sender. | 0 |
sender.rejects | integer | The total number of rejected messages by this sender. | 0 |
sender.complaints | integer | The total number of spam complaints received for messages by this sender. | 0 |
sender.unsubs | integer | The total number of unsubscribe requests received for messages by this sender. | 0 |
sender.opens | integer | The total number of times messages by this sender have been opened. | 0 |
sender.clicks | integer | The total number of times tracked URLs in messages by this sender have been clicked. | 0 |
sender.unique_opens | integer | The number of unique opens for emails sent for this sender. | 0 |
sender.unique_clicks | integer | The number of unique clicks for emails sent for this sender. | 0 |
subaccount | string | The subaccount that this denylist entry applies to, or null if none. | string |
List Tags Copy Link
Return all of the user-defined tag information.
Configuration Table:
| Name* | List Tags |
| Connection* | Select your connection or create one. |
| Time out | You can additionally set the Trigger duration to limit the information processed per execution to optimize performance and resource usage. |
| Recurrence rule/scheduler* | Set up your recurrence rule. |
| Parameters | |
| Retrieve Record by | Selecting “All Records” retrieve all existing records. Choosing “New Record” shows only records created since the last time the flow was executed. |
| Preview Data | Preview the retrieved data. In specific Trigger instances, data can only be previewed when it is available for retrieval. If no event occurs from the Trigger, a message “No data available” will be displayed. |
(*) required field
⚠️ Reminder: Click “Use” to validate your Trigger with sample data before saving.
Mapping Table from this Trigger (use this table to Map your Methods “Input” fields>Input tab>uncheck “Show recommended” to see all fields).
| Field | Description | Value Sample |
|---|---|---|
tag | The name or identifier for the tag. | "string" |
reputation | The reputation score associated with the tag (a numeric value). | 0 |
sent | The total number of emails sent for this tag. | 0 |
hard_bounces | The number of hard bounces (permanent delivery failures) for this tag. | 0 |
soft_bounces | The number of soft bounces (temporary delivery failures) for this tag. | 0 |
rejects | The number of emails rejected by the receiving server for this tag. | 0 |
complaints | The number of spam complaints received for this tag. | 0 |
unsubs | The number of recipients who unsubscribed from emails associated with this tag. | 0 |
opens | The total number of times emails were opened (including multiple opens). | 0 |
clicks | The total number of clicks on links in the emails (including multiple clicks). | 0 |
unique_opens | The number of unique recipients who opened the emails for this tag. | 0 |
unique_clicks | The number of unique recipients who clicked on links in the emails for this tag. | 0 |
Search Message by Hour Copy Link
Search recently sent messages and optionally filter by date range, tags, senders, and return the aggregated hourly stats for matching messages.
Configuration Table:
| Name* | Search Message by Hour |
| Connection* | Select your connection or create one. |
| Time out | You can additionally set the Trigger duration to limit the information processed per execution to optimize performance and resource usage. |
| Recurrence rule/scheduler* | Set up your recurrence rule. |
| Parameters | |
| Search | This field allows you to search for messages using specific keywords or phrases. |
| Start date | Set the beginning date and time of the search range. |
| End Date | Set the end date and time of the search range. |
| Tags[+Add] | You can filter messages by specific tags. You can add multiple tags by clicking the “Add” button. |
| Senders[+Add] | You can filter messages by the sender’s email address. You can add multiple senders by clicking the “Add” button. |
| Limit | the maximum number of results to return, defaults is 100, 1000 is the maximum. |
| Retrieve Record by | Selecting “All Records” retrieve all existing records. Choosing “New Record” shows only records created since the last time the flow was executed. |
| Preview Data | Preview the retrieved data. In specific Trigger instances, data can only be previewed when it is available for retrieval. If no event occurs from the Trigger, a message “No data available” will be displayed. |
(*) required field
⚠️ Reminder: Click “Use” to validate your Trigger with sample data before saving.
Mapping Table from this Trigger (use this table to Map your Methods “Input” fields>Input tab>uncheck “Show recommended” to see all fields).
| Field | Description | Value Samples |
|---|---|---|
time | the hour as a UTC date string in YYYY-MM-DD HH:MM:SS format | “2019-08-24T14:15:22Z” |
sent | the number of emails that were sent during the hour | 0 |
hard_bounces | the number of emails that hard bounced during the hour | 0 |
soft_bounces | the number of emails that soft bounced during the hour | 0 |
rejects | the number of emails that were rejected during the hour | 0 |
complaints | the number of spam complaints received during the hour | 0 |
unsubs | the number of unsubscribes received during the hour | 0 |
opens | the number of emails opened during the hour | 0 |
unique_opens | the number of unique opens generated by messages sent during the hour | 0 |
clicks | the number of tracked URLs clicked during the hour | 0 |
unique_clicks | the number of unique clicks generated by messages sent during the hour | 0 |
List Allowlisted Emails Copy Link
Access your list of approved sender email addresses. You can search for specific emails or use a prefix for broader searching. Up to 1000 results will be displayed.
Configuration Table:
| Name* | List Allowlisted Emails |
| Connection* | Select your connection or create one. |
| Time out | You can additionally set the Trigger duration to limit the information processed per execution to optimize performance and resource usage. |
| Recurrence rule/scheduler* | Set up your recurrence rule. |
| Parameters | |
| Optional email address to search by. | |
| Retrieve Record by | Selecting “All Records” retrieve all existing records. Choosing “New Record” shows only records created since the last time the flow was executed. |
| Preview Data | Preview the retrieved data. In specific Trigger instances, data can only be previewed when it is available for retrieval. If no event occurs from the Trigger, a message “No data available” will be displayed. |
(*) required field
⚠️ Reminder: Click “Use” to validate your Trigger with sample data before saving.
Mapping Table from this Trigger (use this table to Map your Methods “Input” fields>Input tab>uncheck “Show recommended” to see all fields).
| Field | Type | Description | Value Sample |
|---|---|---|---|
email | string | The email that is allowlisted. | Email@sample.com |
detail | string | A description of why the email was allowlisted. | Sample description |
created_at | string | When the email was added to the allowlist. | sample date-time |
List Account Senders Copy Link
List the senders that have tried to use this account, both verified and unverified.
Configuration Table:
| Name* | List Account Senders |
| Connection* | Select your connection or create one. |
| Time out | You can additionally set the Trigger duration to limit the information processed per execution to optimize performance and resource usage. |
| Recurrence rule/scheduler* | Set up your recurrence rule. |
| Parameters | |
| Retrieve record by | Selecting “All Records” retrieve all existing records. Choosing “New Record” shows only records created since the last time the flow was executed. |
| Preview Data | Preview the retrieved data. In specific Trigger instances, data can only be previewed when it is available for retrieval. If no event occurs from the Trigger, a message “No data available” will be displayed. |
(*) required field
⚠️ Reminder: Click “Use” to validate your Trigger with sample data before saving.
Mapping Table from this Trigger (use this table to Map your Methods “Input” fields>Input tab>uncheck “Show recommended” to see all fields).
| Field | Description | Values Samples |
|---|---|---|
id | The unique identifier for the user or email account. | "Wiresk@gmail.com" |
name | The name associated with the user or email account. | "Wiresk@gmail.com" |
created_at | The timestamp when the user or account was created. | "2024-10-10 09:53:08.79119" |
status | The current status of the account. | "active" |
reputation | A numerical value representing the account’s reputation score. | 50 |
sent_weekly | The number of emails sent by the account in the last week. | 0 |
sent_monthly | The number of emails sent by the account in the last month. | 0 |
sent_total | The total number of emails sent by the account. | 0 |
List Inbounds Copy Link
List the domains that have been configured for inbound delivery.
Configuration Table:
| Name* | List Inbounds |
| Connection* | Select your connection or create one. |
| Time out | You can additionally set the Trigger duration to limit the information processed per execution to optimize performance and resource usage. |
| Recurrence rule/scheduler* | Set up your recurrence rule. |
| Parameters | |
| Retrieve Record by | Selecting “All Records” retrieve all existing records. Choosing “New Record” shows only records created since the last time the flow was executed. |
| Preview Data | Preview the retrieved data. In specific Trigger instances, data can only be previewed when it is available for retrieval. If no event occurs from the Trigger, a message “No data available” will be displayed. |
(*) required field
⚠️ Reminder: Click “Use” to validate your Trigger with sample data before saving.
Mapping Table from this Trigger (use this table to Map your Methods “Input” fields>Input tab>uncheck “Show recommended” to see all fields).
| Field | Type | Description | Value Sample |
|---|---|---|---|
domain | string | the domain name that is accepting mail. | string |
created_at | string | the date and time that the inbound domain was added as a UTC string in YYYY-MM-DD HH:MM:SS format. | 2019-08-24T14:15:22Z |
valid_mx | boolean | true if this inbound domain has successfully set up an MX record to deliver mail to the Mandrill servers. | true |
Webhook Triggers Copy Link
The Flow will initiate automatically when a webhook event is received . This means that the Flow is automated without a scheduler and will run until you deactivate the Flow manually.
Mailchimp Webhook Copy Link
Activate your Flow with a Mailchimp Webhook, by watching events in an audience/list.
Configuration Table:
| Description* | Give a descriptive name to this specific webhook. |
| Connection* | Select your Mailchimp connection or create one. |
| API Key* | Select or Create an API Key for authenticating the Webhook request. |
| Parameters | |
| Audience/List ID* | Select the audience you want to monitor, from a dynamic list |
| Webhook Event* | Select an event that will trigger the Webhook. possible choice: Audience/List Subscribe Audience/List Unsubscribe Audience/List Profile updates Audience/List Cleaned Audience/List Email Changes Audience/List Campaign sending |
| Source* | Select the sources of the events you want to monitor. possible values: User, Admin, API |
(*) required field
Mailchimp Transactional Webhook Copy Link
Activate your Flow with a Mailchimp Transactional Webhook, by watching events.
When the Webhook is saved in Wiresk, simultaneously a Webhook in your Mailchimp Transactional will be created too. You will be able to send test to Wiresk.
When the Webhook is saved in Wiresk, simultaneously a Webhook in your Mailchimp Transactional will be created too. You will be able to send test to Wiresk.
Configuration Table:
| Description* | Give a descriptive name to this specific webhook. |
| Connection* | Select your Mailchimp connection or create one. |
| API Key* | Select or Create an API Key for authenticating the Webhook request. |
| Parameters | |
| Webhook Event* | Select an event that will trigger the Webhook. possible values: Message is sent Message is soft-bounced Message is clicked Message recipient unsubscribes Rejection Denylist changes Message is delivered Message is bounced Message is opened Message is marked as spam Message is rejected Rejection Allowlist changes |
| Description | Optional description of the webhook. |
(*) required field
5 – Test run or automate your Flow Copy Link
After setting up your Flow, you can choose to:
- “Run once”, your Flow will run only a single time. You can use this function to test your Flow.
- “Run Scheduler” will automate your Flows with the recurrence rule you previously defined.
For more details, refer to How to run a Flow tutorial in our Help Center.
If you are using a Webhook Trigger, the Flow will initiate automatically when a webhook is received from your connected apps. This means that the Flow is automated without a scheduler and will run until you deactivate the Flow manually. Refer to Webhook documentation in our Help Center.
Learn more about Wiresk, explore our user guide.
If you need an integration that you cannot find in Wiresk, you can make a request to our team, and we will try our best to satisfy your needs.
If you need an integration that you cannot find in Wiresk, you can make a request to our team, and we will try our best to satisfy your needs.