Skip to content
Nappai Documentation

ActiveCampaign Campaigns

The ActiveCampaign Campaigns component allows you to interact with your ActiveCampaign account to retrieve detailed information about your email marketing campaigns. You can use this component to fetch a list of all your campaigns or get specific details about a single campaign using its unique ID.

This node is essential for automating tasks that require reading campaign data, such as generating reports, syncing campaign status with other tools, or verifying campaign details before sending emails.

How it Works

This component connects directly to the ActiveCampaign API to read campaign data. When you run this component, it performs the following actions:

  1. Connects to ActiveCampaign: It uses your configured credentials to securely access your ActiveCampaign account.
  2. Retrieves Data: Depending on your settings, it either lists all campaigns or fetches the details of one specific campaign.
  3. Structures Information: The component organizes the data received from ActiveCampaign into a clear format that you can use in subsequent steps of your automation.

If you are fetching a list of campaigns, you can also apply filters like status or limit the number of results returned. For a specific campaign, the component returns a comprehensive object containing all available attributes like name, subject, status, and sending details.

Connection & Credentials

This component requires configuring a credential in the Nappai panel before interacting with the external service:

  1. Go to the Credentials section in your Nappai panel.
  2. Create a new credential of the type ActiveCampaign and fill in the required fields (API URL and API Key).
    • You can find these in your ActiveCampaign account by going to Settings > Developer.
  3. In your workflow, select the saved credential in the Credential input field of this node.

Inputs

The following fields are available to configure this component:

  • Operation: Select the operation to perform.
  • Get By: Retrieve a single campaign by ID or list all campaigns.
  • Campaign ID: ID of the campaign.
  • Limit: Maximum number of campaigns to return.
  • Status Filter: Filter campaigns by status (only applies when Get By = All).

Outputs

This component produces the following output that can be passed to other nodes in your workflow:

  • Data: A structured object or list containing campaign information. This data includes details such as campaign IDs, names, statuses, dates, and content metadata, which can be used for reporting, filtering, or further processing.

Output Data Example (JSON)

Below is an example of the structure returned in the Data output when retrieving details for a specific campaign: json { “id”: 123456789, “name”: “Newsletter May 2024”, “type”: “regular”, “status”: “active”, “from_name”: “Marketing Team”, “from_email”: “team@company.com”, “subject”: “Check out our latest updates”, “sent_at”: “2024-05-15T10:30:00Z”, “total_sent”: 1500, “created_at”: “2024-04-20T09:00:00Z”, “updated_at”: “2024-05-15T10:35:00Z” }

Connectivity

This component is typically used at the beginning of workflows that involve campaign data. Common connections include:

  • Campaign Detail Nodes: Feed the output to nodes that need specific campaign IDs to update or analyze individual campaigns.
  • Email Senders: Use the retrieved data to verify which campaigns are active before triggering email sending actions.
  • CRM or Spreadsheets: Sync campaign lists to external tools for reporting and analysis.
  • Filters: Use the campaign status or list output to trigger different paths in your automation based on whether a campaign is active, paused, or deleted.

Usage Example

Scenario: Getting a List of Active Campaigns

  1. Configure the Component:
    • Set Operation to retrieve campaigns.
    • Set Get By to “All”.
    • Set Status Filter to “Active” to only get active campaigns.
    • (Optional) Set Limit to a number like 10 if you only need the most recent campaigns.
  2. Execute: Run the component.
  3. Use the Result: Connect the Data output to a For Each loop to process each campaign, or to a Filter node to find campaigns with specific properties.

Tips and Best Practices

  • Use Limits Wisely: When listing all campaigns, consider setting a Limit to avoid returning a very large list that might slow down your workflow.
  • Verify Campaign IDs: If you are fetching a single campaign, ensure the Campaign ID is correct. You can find campaign IDs in your ActiveCampaign dashboard or by first listing campaigns to identify the correct ID.
  • Handle Errors Gracefully: If a campaign ID does not exist or there is an issue with the API, the component will return an error status. Ensure your workflow includes error handling steps to manage these cases.
  • Status Filters: The Status Filter only works when retrieving a list of all campaigns. It helps narrow down results to specific statuses like Active, Paused, or Draft.

Security Considerations

  • API Key Protection: Keep your ActiveCampaign API keys secure. Never share your credentials or expose API keys in public repositories.
  • Least Privilege: Ensure the API key used in your credential has only the necessary permissions required for reading campaign data.
  • Credential Management: Regularly rotate your API keys if your ActiveCampaign account allows, and remove unused credentials from the Nappai panel to maintain security.