Skip to content
Try for free
On this page

Integrations

Loops

Manage contacts and send emails with Loops

Use Loops to manage contacts, send transactional emails, and trigger email sequences with events. Update Contact creates a contact when no match exists. Configure an API key from Loops Settings > API before selecting an operation.

Use the block

Create and manage contacts, send transactional emails, and trigger event-based automations.

Actions

Loops Create Contact

Create a new contact in your Loops audience with an email address and optional properties like name, user group, and mailing list subscriptions.

Inputs and outputs

Input

ParameterTypeRequiredDescription
apiKeystringYesLoops API key for authentication
emailstringYesThe email address for the new contact
firstNamestringNoThe contact first name
lastNamestringNoThe contact last name
sourcestringNoCustom source value replacing the default "API"
subscribedbooleanNoWhether the contact receives campaign emails (defaults to true)
userGroupstringNoGroup to segment the contact into (one group per contact)
userIdstringNoUnique user identifier from your application
mailingListsjsonNoMailing list IDs mapped to boolean values (true to subscribe, false to unsubscribe)
customPropertiesjsonNoCustom contact properties as key-value pairs (string, number, boolean, or date values)

Output

ParameterTypeDescription
successbooleanWhether the contact was created successfully
idstringThe Loops-assigned ID of the created contact

Loops Update Contact

Update an existing contact in Loops by email or userId. Creates a new contact if no match is found (upsert). Can update name, subscription status, user group, mailing lists, and custom properties.

Inputs and outputs

Input

ParameterTypeRequiredDescription
apiKeystringYesLoops API key for authentication
emailstringNoThe contact email address (at least one of email or userId is required)
userIdstringNoThe contact userId (at least one of email or userId is required)
firstNamestringNoThe contact first name
lastNamestringNoThe contact last name
sourcestringNoCustom source value replacing the default "API"
subscribedbooleanNoWhether the contact receives campaign emails (sending true re-subscribes unsubscribed contacts)
userGroupstringNoGroup to segment the contact into (one group per contact)
mailingListsjsonNoMailing list IDs mapped to boolean values (true to subscribe, false to unsubscribe)
customPropertiesjsonNoCustom contact properties as key-value pairs (send null to reset a property)

Output

ParameterTypeDescription
successbooleanWhether the contact was updated successfully
idstringThe Loops-assigned ID of the updated or created contact

Loops Find Contact

Find a contact in Loops by email address or userId. Returns an array of matching contacts with all their properties including name, subscription status, user group, and mailing lists.

Inputs and outputs

Input

ParameterTypeRequiredDescription
apiKeystringYesLoops API key for authentication
emailstringNoThe contact email address to search for (at least one of email or userId is required)
userIdstringNoThe contact userId to search for (at least one of email or userId is required)

Output

ParameterTypeDescription
contactsarrayArray of matching contact objects (empty array if no match found)
↳ idstringLoops-assigned contact ID
↳ emailstringContact email address
↳ firstNamestringContact first name
↳ lastNamestringContact last name
↳ sourcestringSource the contact was created from
↳ subscribedbooleanWhether the contact receives campaign emails
↳ userGroupstringContact user group
↳ userIdstringExternal user identifier
↳ mailingListsobjectMailing list IDs mapped to subscription status
↳ optInStatusstringDouble opt-in status: pending, accepted, rejected, or null

Loops Delete Contact

Delete a contact from Loops by email address or userId. At least one identifier must be provided.

Inputs and outputs

Input

ParameterTypeRequiredDescription
apiKeystringYesLoops API key for authentication
emailstringNoThe email address of the contact to delete (at least one of email or userId is required)
userIdstringNoThe userId of the contact to delete (at least one of email or userId is required)

Output

ParameterTypeDescription
successbooleanWhether the contact was deleted successfully
messagestringStatus message from the API

Loops Send Transactional Email

Send a transactional email to a recipient using a Loops template. Supports dynamic data variables for personalization and optionally adds the recipient to your audience.

Inputs and outputs

Input

ParameterTypeRequiredDescription
apiKeystringYesLoops API key for authentication
emailstringYesThe email address of the recipient
transactionalIdstringYesThe ID of the transactional email template to send
dataVariablesjsonNoTemplate data variables as key-value pairs (string or number values)
addToAudiencebooleanNoWhether to create the recipient as a contact if they do not already exist (default: false)
attachmentsjsonNoArray of file attachments. Each object must have filename (string), contentType (MIME type string), and data (base64-encoded string).

Output

ParameterTypeDescription
successbooleanWhether the transactional email was sent successfully

Loops Send Event

Send an event to Loops to trigger automated email sequences for a contact. Identify the contact by email or userId and include optional event properties and mailing list changes.

Inputs and outputs

Input

ParameterTypeRequiredDescription
apiKeystringYesLoops API key for authentication
emailstringNoThe email address of the contact (at least one of email or userId is required)
userIdstringNoThe userId of the contact (at least one of email or userId is required)
eventNamestringYesThe name of the event to trigger
eventPropertiesjsonNoEvent data as key-value pairs (string, number, boolean, or date values)
mailingListsjsonNoMailing list IDs mapped to boolean values (true to subscribe, false to unsubscribe)

Output

ParameterTypeDescription
successbooleanWhether the event was sent successfully

Loops List Mailing Lists

Retrieve all mailing lists from your Loops account. Returns each list with its ID, name, description, and public/private status.

Inputs and outputs

Input

ParameterTypeRequiredDescription
apiKeystringYesLoops API key for authentication

Output

ParameterTypeDescription
mailingListsarrayArray of mailing list objects
↳ idstringThe mailing list ID
↳ namestringThe mailing list name
↳ descriptionstringThe mailing list description (null if not set)
↳ isPublicbooleanWhether the list is public or private

Loops List Transactional Emails

Retrieve a list of published transactional email templates from your Loops account. Returns each template with its ID, name, created/updated timestamps, and data variables.

Inputs and outputs

Input

ParameterTypeRequiredDescription
apiKeystringYesLoops API key for authentication
perPagestringNoNumber of results per page (10-50, default: 20)
cursorstringNoPagination cursor from a previous response to fetch the next page

Output

ParameterTypeDescription
transactionalEmailsarrayArray of published transactional email templates
↳ idstringThe transactional email template ID
↳ namestringThe template name
↳ createdAtstringCreation timestamp (ISO 8601)
↳ updatedAtstringLast updated timestamp (ISO 8601)
↳ lastUpdatedstringDeprecated alias of updatedAt, kept for backwards compatibility
↳ dataVariablesarrayTemplate data variable names
paginationobjectPagination information
↳ totalResultsnumberTotal number of results
↳ returnedResultsnumberNumber of results returned
↳ perPagenumberResults per page
↳ totalPagesnumberTotal number of pages
↳ nextCursorstringCursor for next page (null if no more pages)
↳ nextPagestringURL for next page (null if no more pages)

Loops Create Contact Property

Create a new custom contact property in your Loops account. The property name must be in camelCase format.

Inputs and outputs

Input

ParameterTypeRequiredDescription
apiKeystringYesLoops API key for authentication
namestringYesThe property name in camelCase format (e.g., "favoriteColor")
typestringYesThe property data type (e.g., "string", "number", "boolean", "date")

Output

ParameterTypeDescription
successbooleanWhether the contact property was created successfully

Loops List Contact Properties

Retrieve a list of contact properties from your Loops account. Returns each property with its key, label, and data type. Can filter to show all properties or only custom ones.

Inputs and outputs

Input

ParameterTypeRequiredDescription
apiKeystringYesLoops API key for authentication
liststringNoFilter type: "all" for all properties (default) or "custom" for custom properties only

Output

ParameterTypeDescription
propertiesarrayArray of contact property objects
↳ keystringThe property key (camelCase identifier)
↳ labelstringThe property display label
↳ typestringThe property data type (string, number, boolean, date)

Loops Check Contact Suppression

Check whether a Loops contact is on the suppression list (bounced, complained, or unsubscribed) by email address or userId.

Inputs and outputs

Input

ParameterTypeRequiredDescription
apiKeystringYesLoops API key for authentication
emailstringNoThe contact email address to check (at least one of email or userId is required)
userIdstringNoThe contact userId to check (at least one of email or userId is required)

Output

ParameterTypeDescription
contactIdstringThe Loops-assigned contact ID
emailstringThe contact email address
userIdstringThe contact userId
isSuppressedbooleanWhether the contact is on the suppression list
removalQuotaLimitnumberTotal suppression-removal quota for the team
removalQuotaRemainingnumberRemaining suppression-removal quota for the team

Loops Remove Contact Suppression

Remove a Loops contact from the suppression list by email address or userId, allowing them to receive emails again. Subject to a team removal quota.

Inputs and outputs

Input

ParameterTypeRequiredDescription
apiKeystringYesLoops API key for authentication
emailstringNoThe contact email address to remove from suppression (at least one of email or userId is required)
userIdstringNoThe contact userId to remove from suppression (at least one of email or userId is required)

Output

ParameterTypeDescription
successbooleanWhether the contact was removed from suppression successfully
messagestringStatus message from the API
removalQuotaLimitnumberTotal suppression-removal quota for the team
removalQuotaRemainingnumberRemaining suppression-removal quota for the team

Loops Get Transactional Email

Retrieve a single transactional email template from your Loops account by its ID, including its data variables and draft/published message IDs.

Inputs and outputs

Input

ParameterTypeRequiredDescription
apiKeystringYesLoops API key for authentication
transactionalIdstringYesThe ID of the transactional email template to retrieve

Output

ParameterTypeDescription
idstringThe transactional email template ID
namestringThe template name
draftEmailMessageIdstringID of the draft email message, if any
publishedEmailMessageIdstringID of the published email message, if any
transactionalGroupIdstringID of the transactional group this template belongs to, if any
createdAtstringCreation timestamp (ISO 8601)
updatedAtstringLast updated timestamp (ISO 8601)
dataVariablesarrayTemplate data variable names

Triggers

A trigger starts a workflow when a supported event occurs in this service.

Loops Campaign Email Sent

Trigger workflow when a Loops campaign email is sent

Configuration and outputs

Configuration

ParameterTypeRequiredDescription
signingSecretstringYesRequired to verify the webhook signature from Loops.

Output

ParameterTypeDescription
eventNamestringEvent type (e.g., campaign.email.sent, loop.email.sent, transactional.email.sent)
eventTimenumberUnix timestamp (seconds) when the event occurred
webhookSchemaVersionstringWebhook schema version (e.g., "1.0.0")
campaignIdstringCampaign ID, present on campaign.email.sent
campaignNamestringCampaign name, present on campaign.email.sent
loopIdstringLoop (workflow) ID, present on loop.email.sent
loopNamestringLoop (workflow) name, present on loop.email.sent
transactionalIdstringTransactional email ID, present on transactional.email.sent
emailjsonEmail object from the payload (id, emailMessageId, subject)
emailIdstringUnique email ID (payload email.id)
emailMessageIdstringSent email message ID (payload email.emailMessageId)
subjectstringEmail subject line (payload email.subject)
contactIdentityjsonContact identity object from the payload (id, email, userId)
contactIdstringContact ID (payload contactIdentity.id)
contactEmailstringContact email address (payload contactIdentity.email)
userIdstringContact user ID, when set (payload contactIdentity.userId)
mailingListsjsonMailing lists the send targeted (id, name, description, isPublic); present on campaign and loop sends

Loops Email Clicked

Trigger workflow when a link in a Loops email is clicked

Configuration and outputs

Configuration

ParameterTypeRequiredDescription
signingSecretstringYesRequired to verify the webhook signature from Loops.

Output

ParameterTypeDescription
eventNamestringEvent type (e.g., email.delivered, email.opened, email.clicked)
eventTimenumberUnix timestamp (seconds) when the event occurred
webhookSchemaVersionstringWebhook schema version (e.g., "1.0.0")
sourceTypestringSource of the email: "campaign", "loop", or "transactional"
campaignIdstringCampaign ID, present when sourceType is "campaign"
loopIdstringLoop (workflow) ID, present when sourceType is "loop"
transactionalIdstringTransactional email ID, present when sourceType is "transactional"
emailjsonEmail object from the payload (id, emailMessageId, subject)
emailIdstringUnique email ID (payload email.id)
emailMessageIdstringSent email message ID (payload email.emailMessageId)
subjectstringEmail subject line (payload email.subject)
contactIdentityjsonContact identity object from the payload (id, email, userId)
contactIdstringContact ID (payload contactIdentity.id)
contactEmailstringContact email address (payload contactIdentity.email)
userIdstringContact user ID, when set (payload contactIdentity.userId)

Loops Email Delivered

Trigger workflow when a Loops email is delivered

Configuration and outputs

Configuration

ParameterTypeRequiredDescription
signingSecretstringYesRequired to verify the webhook signature from Loops.

Output

ParameterTypeDescription
eventNamestringEvent type (e.g., email.delivered, email.opened, email.clicked)
eventTimenumberUnix timestamp (seconds) when the event occurred
webhookSchemaVersionstringWebhook schema version (e.g., "1.0.0")
sourceTypestringSource of the email: "campaign", "loop", or "transactional"
campaignIdstringCampaign ID, present when sourceType is "campaign"
loopIdstringLoop (workflow) ID, present when sourceType is "loop"
transactionalIdstringTransactional email ID, present when sourceType is "transactional"
emailjsonEmail object from the payload (id, emailMessageId, subject)
emailIdstringUnique email ID (payload email.id)
emailMessageIdstringSent email message ID (payload email.emailMessageId)
subjectstringEmail subject line (payload email.subject)
contactIdentityjsonContact identity object from the payload (id, email, userId)
contactIdstringContact ID (payload contactIdentity.id)
contactEmailstringContact email address (payload contactIdentity.email)
userIdstringContact user ID, when set (payload contactIdentity.userId)

Loops Email Hard Bounced

Trigger workflow when a Loops email hard bounces

Configuration and outputs

Configuration

ParameterTypeRequiredDescription
signingSecretstringYesRequired to verify the webhook signature from Loops.

Output

ParameterTypeDescription
eventNamestringEvent type (e.g., email.delivered, email.opened, email.clicked)
eventTimenumberUnix timestamp (seconds) when the event occurred
webhookSchemaVersionstringWebhook schema version (e.g., "1.0.0")
sourceTypestringSource of the email: "campaign", "loop", or "transactional"
campaignIdstringCampaign ID, present when sourceType is "campaign"
loopIdstringLoop (workflow) ID, present when sourceType is "loop"
transactionalIdstringTransactional email ID, present when sourceType is "transactional"
emailjsonEmail object from the payload (id, emailMessageId, subject)
emailIdstringUnique email ID (payload email.id)
emailMessageIdstringSent email message ID (payload email.emailMessageId)
subjectstringEmail subject line (payload email.subject)
contactIdentityjsonContact identity object from the payload (id, email, userId)
contactIdstringContact ID (payload contactIdentity.id)
contactEmailstringContact email address (payload contactIdentity.email)
userIdstringContact user ID, when set (payload contactIdentity.userId)

Loops Email Opened

Trigger workflow when a Loops email is opened

Configuration and outputs

Configuration

ParameterTypeRequiredDescription
signingSecretstringYesRequired to verify the webhook signature from Loops.

Output

ParameterTypeDescription
eventNamestringEvent type (e.g., email.delivered, email.opened, email.clicked)
eventTimenumberUnix timestamp (seconds) when the event occurred
webhookSchemaVersionstringWebhook schema version (e.g., "1.0.0")
sourceTypestringSource of the email: "campaign", "loop", or "transactional"
campaignIdstringCampaign ID, present when sourceType is "campaign"
loopIdstringLoop (workflow) ID, present when sourceType is "loop"
transactionalIdstringTransactional email ID, present when sourceType is "transactional"
emailjsonEmail object from the payload (id, emailMessageId, subject)
emailIdstringUnique email ID (payload email.id)
emailMessageIdstringSent email message ID (payload email.emailMessageId)
subjectstringEmail subject line (payload email.subject)
contactIdentityjsonContact identity object from the payload (id, email, userId)
contactIdstringContact ID (payload contactIdentity.id)
contactEmailstringContact email address (payload contactIdentity.email)
userIdstringContact user ID, when set (payload contactIdentity.userId)

Loops Email Soft Bounced

Trigger workflow when a Loops email soft bounces

Configuration and outputs

Configuration

ParameterTypeRequiredDescription
signingSecretstringYesRequired to verify the webhook signature from Loops.

Output

ParameterTypeDescription
eventNamestringEvent type (e.g., email.delivered, email.opened, email.clicked)
eventTimenumberUnix timestamp (seconds) when the event occurred
webhookSchemaVersionstringWebhook schema version (e.g., "1.0.0")
sourceTypestringSource of the email: "campaign", "loop", or "transactional"
campaignIdstringCampaign ID, present when sourceType is "campaign"
loopIdstringLoop (workflow) ID, present when sourceType is "loop"
transactionalIdstringTransactional email ID, present when sourceType is "transactional"
emailjsonEmail object from the payload (id, emailMessageId, subject)
emailIdstringUnique email ID (payload email.id)
emailMessageIdstringSent email message ID (payload email.emailMessageId)
subjectstringEmail subject line (payload email.subject)
contactIdentityjsonContact identity object from the payload (id, email, userId)
contactIdstringContact ID (payload contactIdentity.id)
contactEmailstringContact email address (payload contactIdentity.email)
userIdstringContact user ID, when set (payload contactIdentity.userId)

Loops Loop Email Sent

Trigger workflow when a Loops loop email is sent

Configuration and outputs

Configuration

ParameterTypeRequiredDescription
signingSecretstringYesRequired to verify the webhook signature from Loops.

Output

ParameterTypeDescription
eventNamestringEvent type (e.g., campaign.email.sent, loop.email.sent, transactional.email.sent)
eventTimenumberUnix timestamp (seconds) when the event occurred
webhookSchemaVersionstringWebhook schema version (e.g., "1.0.0")
campaignIdstringCampaign ID, present on campaign.email.sent
campaignNamestringCampaign name, present on campaign.email.sent
loopIdstringLoop (workflow) ID, present on loop.email.sent
loopNamestringLoop (workflow) name, present on loop.email.sent
transactionalIdstringTransactional email ID, present on transactional.email.sent
emailjsonEmail object from the payload (id, emailMessageId, subject)
emailIdstringUnique email ID (payload email.id)
emailMessageIdstringSent email message ID (payload email.emailMessageId)
subjectstringEmail subject line (payload email.subject)
contactIdentityjsonContact identity object from the payload (id, email, userId)
contactIdstringContact ID (payload contactIdentity.id)
contactEmailstringContact email address (payload contactIdentity.email)
userIdstringContact user ID, when set (payload contactIdentity.userId)
mailingListsjsonMailing lists the send targeted (id, name, description, isPublic); present on campaign and loop sends

Loops Transactional Email Sent

Trigger workflow when a Loops transactional email is sent

Configuration and outputs

Configuration

ParameterTypeRequiredDescription
signingSecretstringYesRequired to verify the webhook signature from Loops.

Output

ParameterTypeDescription
eventNamestringEvent type (e.g., campaign.email.sent, loop.email.sent, transactional.email.sent)
eventTimenumberUnix timestamp (seconds) when the event occurred
webhookSchemaVersionstringWebhook schema version (e.g., "1.0.0")
campaignIdstringCampaign ID, present on campaign.email.sent
campaignNamestringCampaign name, present on campaign.email.sent
loopIdstringLoop (workflow) ID, present on loop.email.sent
loopNamestringLoop (workflow) name, present on loop.email.sent
transactionalIdstringTransactional email ID, present on transactional.email.sent
emailjsonEmail object from the payload (id, emailMessageId, subject)
emailIdstringUnique email ID (payload email.id)
emailMessageIdstringSent email message ID (payload email.emailMessageId)
subjectstringEmail subject line (payload email.subject)
contactIdentityjsonContact identity object from the payload (id, email, userId)
contactIdstringContact ID (payload contactIdentity.id)
contactEmailstringContact email address (payload contactIdentity.email)
userIdstringContact user ID, when set (payload contactIdentity.userId)
mailingListsjsonMailing lists the send targeted (id, name, description, isPublic); present on campaign and loop sends
Was this helpful?
Suggest an edit