Loops

Create contacts and send events in Loops email platform.

MarketingAPI key6 actionsAll integrations

On this page

Connect
Call it from a workflow
Actions (6)
create_contact
send_event
custom_api_call
delete_contact
find_contact
send_transactional_email
Details

Connect

Auth type: API key (secret_text). Paste the API key (or token) from the provider's settings into the connect dialog. It is encrypted at rest and only decrypted on the server when an action runs.

In the editor: Backend panel, Integrations tab, then Connect. This connects it for the project.
For every project in a workspace: Workspace settings, Integrations.
Owners and admins choose which integrations members may connect in the admin panel (Integrations tab), and can attach their own OAuth app there.

Call it from a workflow

Pass the action name and its input. The call resolves with { success, output, error? }; a missing connection resolves with success false and the reason. See ctx.integrations.invoke and ctx.integrations.call.

Native workflow

// .workflow.js (native ctx)
export async function run(ctx) {
  const res = await ctx.integrations.invoke("loops", "create_contact", {
    "email": "<email>"
  });
  if (!res.success) throw new Error(res.error);
  ctx.log.info("Loops answered", { output: res.output });
}

defineWorkflow module

// defineWorkflow module (@app/sdk ctx)
import { defineWorkflow } from "@app/sdk";

export default defineWorkflow({
  id: "loops-create-contact",
  name: "Loops: Create Contact",
  description: "Calls Loops when a row is created.",
  trigger: { type: "entity_event", entity: "tickets", event: "created" },
  async run(ctx, event) {
    const res = await ctx.integrations.call("loops", {
      "action": "create_contact",
      "email": "<email>"
    }) as { success: boolean; error?: string };
    if (!res.success) throw new Error(res.error);
  },
});

From an app (connector proxy)

curl -X POST "$APP_ORIGIN/__appbricx/connector-proxy/loops/create_contact" \
  -H "Authorization: Bearer $APP_KEY" \
  -H "content-type: application/json" \
  -d '{"props":{"email":"<email>"}}'

Actions

create_contactin catalog

Create Contact. Creates a new contact in Loops. Returns an error if a contact with the given email already exists.

Input	Type	Description
`email`required	text	The email address of the contact.
`firstName`optional	text	The contact's first name.
`lastName`optional	text	The contact's last name.
`userId`optional	text	Your internal user ID for this contact.
`subscribed`optional	one of "no_change" \| "true" \| "false"	Set subscription status. Leave as "No Change" to preserve existing status on update.
`userGroup`optional	text	A group/segment to assign to this contact.
`source`optional	text	Where this contact came from (e.g. "signup-form", "import").
`mailingLists`optional	object	Subscribe or unsubscribe this contact from mailing lists. Provide list IDs as keys with `true` (subscribe) or `false` (unsubscribe) as values.
`customProperties`optional	object	Additional custom contact properties as key-value pairs. Reserved fields (email, firstName, lastName, userId, subscribed, userGroup, source) are ignored here.

send_eventin catalog

Send Event. Sends an event to Loops for a contact. Events can trigger email automations configured in your Loops dashboard.

Input	Type	Description
`email`optional	text	The email address of the contact to send the event for.
`userId`optional	text	Your internal user ID of the contact (used if email is not provided).
`eventName`required	text	The name of the event to send (e.g. "signup", "purchase", "password-reset"). Must match an event set up in Loops.
`eventProperties`optional	object	Optional key-value pairs to attach to the event (used in email templates).
`mailingLists`optional	object	Subscribe or unsubscribe this contact from mailing lists. Provide list IDs as keys with `true` (subscribe) or `false` (unsubscribe) as values.
`contactProperties`optional	object	Optional contact property updates to apply when the event is sent.

custom_api_call

Custom API Call. Make a custom API call to a specific endpoint

Input	Type	Description
`url`required	object (depends on other props)	url
`method`required	one of "GET" \| "POST" \| "PATCH" \| "PUT" \| "DELETE" \| "HEAD"	Method
`headers`required	object	Authorization headers are injected automatically from your connection.
`queryParams`required	object	Query Parameters
`body_type`optional	one of "none" \| "json" \| "form_data" \| "raw"	Body Type
`body`optional	object (depends on other props)	Body
`response_is_binary`optional	boolean	Enable for files like PDFs, images, etc.
`failsafe`optional	boolean	No Error on Failure
`timeout`optional	number	Timeout (in seconds)
`followRedirects`optional	boolean	Follow redirects

delete_contact

Delete Contact. Permanently deletes a contact from Loops by their email address or user ID.

Input	Type	Description
`email`optional	text	The email address of the contact to delete.
`userId`optional	text	Your internal user ID of the contact to delete.

find_contact

Find Contact. Finds a contact in Loops by their email address or user ID.

Input	Type	Description
`searchBy`required	one of "email" \| "userId"	The field to search by. The Loops API only allows one search parameter.
`searchValue`required	text	The email address or user ID to search for.

send_transactional_email

Send Transactional Email. Sends a transactional email to a contact using a pre-built template in Loops.

Input	Type	Description
`email`required	text	The recipient's email address.
`transactionalId`required	text	The ID of the transactional email template in Loops (find it in your Loops dashboard).
`addToAudience`optional	boolean	If true, the recipient will be added to your Loops audience if they are not already a contact.
`dataVariables`optional	object	Key-value pairs to populate dynamic variables in your email template (e.g. { "name": "Alice", "resetUrl": "https://..." }).

Details

Id: loops
Category: Marketing
Tags: email, transactional, product-email, saas
Package: @activepieces/piece-loops@0.0.1
Tier: Community