@optimizely-campaign/n8n-nodes-optimizely-campaign
v0.1.2
Published
n8n community node for interacting with the Optimizely Campaign API
Maintainers
Keywords
Readme
n8n-nodes-optimizely-campaign
This package provides n8n community nodes for interacting with the Optimizely Campaign API.
It enables you to process response data in real time using webhooks, manage recipients, and send transactional emails directly from your n8n workflows.
Features
📡 Webhook Trigger
- Receive and process response data from Optimizely Campaign in real time
- Ideal for event-driven and reactive workflows
👥 Recipient Management
- Create new recipients
- Update existing recipients
- Manage recipient data programmatically
✉️ Transactional Emails
- Send transactional emails via Optimizely Campaign
- Integrate email delivery into automated workflows
Installation
Community Nodes (self-hosted)
- Open Settings → Community Nodes
- Click Install
- Enter the package name:
@optimizely-campaign/n8n-nodes-optimizely-campaign - Click Install
Manual Installation (self-hosted)
npm install @optimizely-campaign/n8n-nodes-optimizely-campaignAfter installation, restart your n8n instance to load the new nodes.
Credentials
To use this node, you need Optimizely Campaign API credentials. These must be requested from Optimizely Campaign Support.
How to obtain API credentials:
- Contact Optimizely Campaign Support at [email protected]
- Request an API user for your Optimizely Campaign account
- You will receive:
- API Username (API-User)
- API Password
- Client ID (mandator ID)
Setting up credentials in n8n:
- In n8n, go to Credentials → New
- Search for Optimizely Campaign API
- Enter your credentials:
- API-User: Your API username
- Password: Your API password
- Client: Your Client/Mandator ID
- Click Save
The credentials will be automatically tested by calling the /users/authenticated endpoint.
Compatibility
Tested with:
- n8n version 1.112.0 and later
- Optimizely Campaign API (REST API v1)
Usage
Example 1: Create a Recipient
- Add the Optimizely Campaign node to your workflow
- Select Recipient as the resource
- Select Create as the operation
- Choose your recipient list
- Select the recipient ID field (usually email)
- Map your data fields using the Resource Mapper
- Optionally trigger an opt-in process
Example 2: Send Transactional Email
- Add the Optimizely Campaign node
- Select Transactional Mail as the resource
- Choose your transactional mailing
- Select the recipient list
- Map recipient data including the ID field
- Execute to send the email
Example 3: Webhook Trigger for Campaign Events
- Add the Optimizely Campaign Trigger node
- Select the event type (e.g., Click, Open, Bounce)
- The webhook URL will be automatically registered with Optimizely Campaign
- Process incoming webhook data in your workflow
Operations
Recipient Resource
- Create: Create a new recipient in a recipient list
- Get Recipient: Retrieve recipient data with selected attributes
- Update: Update an existing recipient's data
Transactional Mail Resource
- Send: Send a transactional email to a recipient
Webhook Trigger
Available events:
- Archive, Blocklist, Bounce, Click, Confirmed Opt-In, Double Opt-In
- Filtered by Blocklist, Open, Sent, Single Opt-In, Spam Complaint, Unsubscribe
Resources
- n8n Community Nodes Documentation
- Optimizely Campaign API Documentation
- Optimizely Campaign
- GitHub Repository
Support
For issues or questions:
- API Access & Credentials: Contact [email protected]
- General Questions: Refer to the Optimizely Campaign Support
License
Developed by: Optimizely Campaign Integration Management Team
