solidarity-tech

n8n node for Solidarity Tech API integration

Package Information

Released: 13 mo ago
Downloads: 11 weekly / 146 monthly
Latest Version: 10.1.8
Author: The Red Flag

Documentation

@theredflag/n8n-nodes-solidarity-tech

n8n.io - Workflow Automation

An n8n community node for integrating with the Solidarity Tech API. This node allows you to manage users, events, notes, relationships, and more within your n8n workflows.

Installation

Follow the installation guide in the n8n community nodes documentation.

Community Nodes (Recommended)

  1. Go to Settings > Community Nodes
  2. Select Install
  3. Enter @theredflag/n8n-nodes-solidarity-tech
  4. Agree to the risks of using community nodes (if prompted)
  5. Select Install

Manual Installation

To get started install the package in your n8n root directory:

npm install n8n-nodes-solidarity-tech

For Docker-based deployments add the following line before the font installation command in your n8n Dockerfile:

RUN cd /usr/local/lib/node_modules/n8n && npm install @theredflag/n8n-nodes-solidarity-tech

Development Setup

To build the node from source:

git clone https://github.com/theredflag/n8n-nodes-solidarity-tech.git
cd n8n-nodes-solidarity-tech
npm install
npm run build

Icon Replacement

To use the official Solidarity Tech favicon instead of the default icon:

  1. Download the favicon from: https://irdu.s3.amazonaws.com/favicons/st/favicon.ico
  2. Convert it to SVG format (64x64 pixels recommended)
  3. Replace nodes/SolidarityTech/solidaritytech.svg with your converted SVG

Features

User Management

The Solidarity Tech node supports comprehensive user management including:

  • Creating and updating user records
  • Setting contact permissions (SMS, call, email)
  • Managing user tags (add/remove)
  • Setting address information
  • Custom User Properties: Add unlimited custom key-value properties to users

Custom User Properties

You can add custom properties to users during create or update operations. This feature allows you to store additional metadata about users beyond the standard fields.

Example custom properties:

  • Member Status: "Member in Good Standing"
  • Volunteer Role: "Phone Bank Coordinator"
  • Join Date: "2024-01-15"
  • Skills: "Organizing, Data Entry, Spanish Translation"
  • Availability: "Weekends and Evenings"

Custom properties are sent to the API as part of the custom_user_properties object:

{
	"custom_user_properties": {
		"Member Status": "Member in Good Standing",
		"Volunteer Role": "Phone Bank Coordinator",
		"Join Date": "2024-01-15"
	}
}

To add custom properties in n8n:

  1. Select User as the resource
  2. Choose Create or Update or Update operation
  3. Scroll down to Custom User Properties
  4. Click Add Custom Property
  5. Enter the property name and value
  6. Add as many properties as needed
  7. Rebuild the package with npm run build

Credentials

The Solidarity Tech node requires API credentials. You'll need:

  1. API Key: Your Solidarity Tech API key
  2. Base URL: The API endpoint URL
    • Production: https://api.solidarity.tech/v1

Setting up credentials

  1. In n8n, go to Credentials
  2. Click Add Credential
  3. Select Solidarity Tech API
  4. Enter your API key and base URL
  5. Test the connection
  6. Save the credential

Supported Operations

Users

  • Create or Update: Create a new user or update an existing one
  • Get: Retrieve a specific user by ID
  • Get Many: List multiple users with pagination
  • Update: Update an existing user

User Notes

  • Create: Add a note to a user
  • Delete: Remove a user note

User Actions

  • Create: Record a user action (petition signature, pledge, etc.)
  • Get Many: List user actions

User Relationships

  • Create: Create a relationship between users
  • Delete: Remove a user relationship
  • Get Types: List available relationship types

Events

  • Get Many: List events with pagination

Event Sessions

  • Create: Create a new event session
  • Get: Retrieve an event session
  • Update: Update an event session
  • Delete: Remove an event session

Event RSVPs

  • Create: Create an RSVP for an event
  • Get Many: List event RSVPs

Event Attendance

  • Create: Record event attendance
  • Get Many: List attendance records
  • Delete: Remove an attendance record

User Lists

  • Create: Create a new user list/segment

Usage Examples

Creating a User

{
	"resource": "user",
	"operation": "upsert",
	"phoneNumber": "+1234567890",
	"email": "user@example.com",
	"firstName": "John",
	"lastName": "Doe",
	"smsPermission": true,
	"emailPermission": true
}

Recording Event Attendance

{
	"resource": "eventAttendance",
	"operation": "create",
	"eventId": "123",
	"eventSessionId": "456",
	"userId": "789",
	"attended": true
}

Creating a User Note

{
	"resource": "userNote",
	"operation": "create",
	"userId": "123",
	"content": "Follow up needed regarding membership renewal",
	"agentId": 1
}

Rate Limiting

The Solidarity Tech API has a rate limit of approximately 4 requests per second. This node automatically includes a 250-300ms delay between paginated requests to respect these limits.

Error Handling

The node includes comprehensive error handling:

  • Authentication errors: Invalid API key or credentials
  • Rate limiting: Automatic retries with exponential backoff
  • Validation errors: Missing required fields or invalid data
  • Network errors: Connection timeouts and server errors

Enable "Continue on Fail" in your node settings to handle errors gracefully in your workflow.

Field Mappings

User Fields

n8n Field API Field Type Required
phoneNumber phone_number string Yes (for upsert)
email email string No
firstName first_name string No
lastName last_name string No
preferredLanguage preferred_language string No
secondLanguage second_language string No
chapterId chapter_id integer No
smsPermission sms_permission boolean No
callPermission call_permission boolean No
emailPermission email_permission boolean No

Address Fields

n8n Field API Field Type
address1 address1 string
city city string
state state string
postal_code postal_code string
country country string
lat lat number
lon lon number

API Documentation

For detailed API documentation, visit:

Support

For issues related to this n8n node:

  1. Check the Issues page
  2. Create a new issue with detailed information about your problem

For Solidarity Tech API issues:

For organization/npm package issues:

Contributing

Contributions are welcome! Please read our contributing guidelines and submit pull requests to the repository.

License

MIT

Changelog

1.0.0

  • Initial release
  • Support for all core Solidarity Tech API resources
  • Comprehensive field mapping
  • Rate limiting and error handling
  • Complete TypeScript implementation
  • Built-in SVG icon (replaceable with official favicon)

Publishing

To publish a new version:

# Update version in package.json
npm version patch  # or minor/major

# Build and publish
npm run publish

Note: This is a community node maintained by The Red Flag organization. It is not maintained by the n8n team. Please use it at your own discretion and always test thoroughly before using in production workflows.

Discussion