n8n Nodes for Autocust

This project provides a collection of nodes for n8n, allowing you to connect to and automate workflows with the Autocust marketing SaaS platform.

This package allows you to manage contacts, lists, send messages, and trigger workflows based on events within Autocust.

Prerequisites

Before you can use these nodes, you must have:

• An active Autocust account.
• Your Autocust API Base URL and API Key.
• A running n8n instance.

Installation

1. Download this project's source code.
2. Follow the n8n documentation for installing community nodes.

Configuration

Once the nodes are installed, you need to configure the credentials to allow n8n to communicate with Autocust.

1. In your n8n instance, go to the Credentials section.
2. Click Add credential and search for Autocust API.
3. Fill in the following fields:
   • API Base URL: The base URL for your Autocust API.
   • API Key: Your Autocust API key.
4. Click Save.

Nodes

This package includes the following nodes:

Contact Action

Manage contacts in Autocust. This node allows you to perform the following operations:

• Create Contact: Create a new contact with default and custom attributes.
• Get Single Contact: Retrieve a single contact by their ID or email address.
• Get Many Contacts: Retrieve a list of contacts with powerful filtering, sorting, and pagination options (limit and skip).
• Edit Contact: Update an existing contact's attributes or list assignments.
• Delete Contact: Remove a contact from Autocust.

List Action

Manage the relationship between contacts and lists.

• Add Contact To List: Associate a contact with a specific list.
• Remove Contact From List: Disassociate a contact from a specific list.

Send Message

Send transactional messages to your contacts through various channels.

• Operations: Supports sending templated messages via SMS, WhatsApp, and Email.
• Custom Fields: Personalize your messages by passing custom field data.

Message Activity

Check the engagement status for a specific message and contact.

• Operations: You can check if a message was Opened or Clicked.

Workflow Enter / Workflow Exit

These two nodes allow you to register when a contact enters or exits a specific part of your n8n workflow.

• Workflow Enter: Creates an event in Autocust marking when a contact has started a workflow.
• Workflow Exit: Creates an event in Autocust marking when a contact has finished a workflow.

Workflow Activation Trigger

This is a trigger node that starts a workflow based on events that happen in Autocust.

• Events: You can trigger workflows on:
  • New Contact Created
  • Contact Updated
  • Contact Blocklisted
  • Campaign Sent

Development

Requirements

• Node.js v22
• pnpm
• A global n8n installation (npm install -g n8n)

Setup

1. If you have not run n8n before, start it once with n8n start.
2. Clone this repository and install its dependencies: pnpm install
3. Build the project: pnpm run build
4. Create a symbolic link to this package in your global node_modules: npm link
5. Navigate to the n8n custom nodes directory: cd ~/.n8n/custom
6. Link the package into n8n: npm link n8n-nodes-autocust
7. Restart n8n.

License

This project is unlicensed.