Skip to content

Sweeppea-Development-Lab/sweeppea-n8n-nodes

Repository files navigation

Sweeppea Node for n8n

Community node for integrating Sweeppea sweepstakes platform with n8n workflows.

Sweeppea is a sweepstakes management platform that helps businesses create and manage promotional campaigns, contests, and giveaways.

n8n is a fair-code licensed workflow automation platform.

Installation

Follow the installation guide in the n8n community nodes documentation.

Operations

Participant

  • Get Form Fields - Retrieve the dynamic entry form fields for a specific sweepstake (useful for building chatbots or dynamic forms)
  • Create - Register a new participant in a sweepstake with dynamic field support

Credentials

You'll need to configure your Sweeppea API credentials:

  1. API Token/Key - Your Sweeppea API authentication token
  2. Environment - Select your target environment:

How to get your API credentials

  1. Log in to your Sweeppea Dashboard
  2. Navigate to the API Keys tab
  3. Generate or copy your API token
  4. Use this token in the n8n credential configuration

Compatibility

  • Minimum n8n version: 0.199.0
  • Tested with n8n version: 1.0.0+

Usage

Dynamic Field Support

The Sweeppea node supports fully dynamic form fields. Each sweepstake can have different fields configured in the Sweeppea platform, and the node automatically adapts to these fields.

Example workflow:

  1. Use Get Form Fields operation to fetch the required fields for a sweepstake
  2. Build a dynamic form or chatbot that collects the required data
  3. Use Create operation to register the participant with the collected data

AI Chatbot Integration

This node works seamlessly with AI agents (OpenAI, Anthropic, etc.) to create conversational participant registration flows:

  1. Fetch sweepstake form fields
  2. Build dynamic system prompt with required fields
  3. AI agent collects data conversationally
  4. Transform AI response to API format
  5. Create participant automatically

Field Name Format

When submitting participant data, field names should use underscores instead of spaces:

  • "First Name" → First_Name
  • "How did you find us?" → How_did_you_find_us?

The node expects data in this format:

{
  "KeyEmail": "user@example.com",
  "KeyPhoneNumber": "1234567890",
  "BonusEntries": 0,
  "Fields": {
    "First_Name": "John",
    "Last_Name": "Doe",
    "Email": "user@example.com",
    "Mobile_Number": "1234567890",
    "Custom_Field": "value"
  }
}

⚠️ IMPORTANT: Mandatory Error Handling Configuration

BEFORE USING THIS NODE, you MUST configure error handling:

  1. Click on the Sweeppea node
  2. Go to Settings tab (not Parameters)
  3. Under On Error, change from "Stop Workflow" to Continue

Error Handling Configuration

This configuration is MANDATORY for the node to work correctly. Without it, duplicate participants or validation errors will stop your entire workflow instead of being handled gracefully.

Why is this required?

  • The node is designed to pass error responses (like duplicate entries) as data to the next node
  • This allows you to handle errors in your workflow logic (show messages, log, retry, etc.)
  • Without "Continue" enabled, the workflow will crash on the first error

Example Workflows

This package includes ready-to-import example workflows in the /examples folder:

1. Simple Participant Registration

File: sweeppea-create-participant.json

Simple Workflow

A straightforward workflow that collects participant data through an AI chatbot:

  • AI Agent asks for First Name, Last Name, Email, and Mobile Number conversationally
  • Transform node converts the collected data to Sweeppea API format
  • Creates participant in the sweepstake

How to use:

  1. Import the workflow JSON file into your n8n instance
  2. Configure your Sweeppea credentials
  3. Replace YOUR_SWEEPSTAKES_TOKEN_HERE with your actual sweepstakes token
  4. Activate the workflow

2. Dynamic Form Registration

File: sweeppea-create-participant-dynamic-form.json

Dynamic Workflow

An advanced workflow that automatically adapts to any sweepstake configuration:

  • Fetches the sweepstake form fields dynamically from the API
  • Builds a custom AI system prompt based on the field configuration
  • AI Agent collects all fields conversationally (even optional ones)
  • Transform node dynamically maps collected data to API format
  • Creates participant with all custom fields

How to use:

  1. Import the workflow JSON file into your n8n instance
  2. Configure your Sweeppea credentials
  3. Replace YOUR_SWEEPSTAKES_TOKEN_HERE with your actual sweepstakes token (appears in 2 nodes)
  4. Activate the workflow

Note: The dynamic workflow automatically adapts to any sweepstake configuration, making it ideal for use across multiple campaigns with different field requirements.

Resources

Version history

0.1.0 (2025-11-19)

Initial Release

  • Dynamic field loading based on sweepstake configuration (API v3)
  • Support for Get Form Fields operation
  • Support for Create Participant operation
  • Multi-environment support (production, development)
  • Automatic field validation
  • Support for multiple field types:
    • Text fields
    • Email
    • Phone numbers (US format)
    • Dates/Birthdate
    • Numbers
    • Select lists
  • AI chatbot integration support

License

MIT


© 2025 Sweeppea Development Lab

About

Sweeppea N8N Nodes

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors