Skip to content

SynthFlowAI/n8n-synthflow-node

Repository files navigation

@synthflow-ai/n8n-nodes-synthflow

This is an n8n community node that lets you use Synthflow AI in your n8n workflows.

Synthflow AI enables you to create and manage AI-powered voice agents and make outbound calls automatically via the Synthflow API.

n8n is a fair-code licensed workflow automation platform.

Installation
Operations
Credentials
Compatibility
Usage
Resources

Installation

Follow the installation guide in the n8n community nodes documentation.

Community Node Installation

  1. Go to Settings > Community Nodes
  2. Select Install
  3. Enter @synthflow-ai/n8n-nodes-synthflow in Enter npm package name
  4. Agree to the risks of using community nodes
  5. Select Install

After installing the node, you can use it like any other node. n8n displays the node in search results in the Nodes panel.

Manual Installation

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

npm install @synthflow-ai/n8n-nodes-synthflow

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 @synthflow-ai/n8n-nodes-synthflow

Operations

Make a Call

Initiates an outbound phone call using a Synthflow AI agent.

Required Parameters:

  • Model ID: The ID of your Synthflow AI agent
  • Phone Number: Recipient's phone number in E.164 format (e.g., +1234567890)
  • Recipient Name: Name of the person being called

Optional Parameters:

  • Lead Email: Customer's email for appointment booking
  • Lead Timezone: Customer's timezone in IANA format (e.g., Europe/Berlin, America/New_York). See Synthflow's time zone reference in the docs.
  • External Webhook URL: Post-call webhook URL that will receive call data (such as status, transcript, and metadata). See the post-call webhook section in the Synthflow docs.
  • Prompt: Custom prompt to override the agent's default behavior
  • Greeting: Custom greeting message for when the call is answered
  • Custom Variables: Key-value pairs that map to Synthflow's Custom Variables feature and can be dynamically injected into your agent's prompt for personalization

Call Operations

Retrieve and analyze call data:

  • Get Call: Retrieve the transcript and metadata for a specific call by call_id. Returns detailed call information including transcript, duration, recording URL, end call reason, executed actions, and more.
  • List Calls: Get a paginated list of calls for a specific agent with optional filters:
    • Required: Model ID
    • Optional filters: Date range (from/to), call status, duration range (min/max), lead phone number
    • Returns pagination info and array of call records

Agent Operations

In addition to making calls, the Synthflow node can manage your Synthflow agents:

  • Create Agent: Create a new Synthflow AI agent (outbound, inbound, or widget) including prompt, voice, language, and call behavior.
  • Get Agent: Retrieve a single Synthflow agent by its model_id.
  • List Agents: List Synthflow agents in your account using limit/offset pagination.
  • Update Agent: Update an existing Synthflow agent's configuration, including type, name, webhooks, recording settings, max duration, or full agent JSON.
  • Delete Agent: Delete a Synthflow agent by model_id.

Credentials

To use this node, you need a Synthflow API account and an API token.

  1. Sign up for a Synthflow account
  2. Navigate to your account settings to generate an API token
  3. In n8n, create new credentials of type "Synthflow API"
  4. Paste your API token into the credentials

Compatibility

This node has been tested with:

  • n8n version: 1.0.0+
  • Node.js version: 18.x, 20.x

Usage

Basic Example

  1. Add the Synthflow node to your workflow
  2. Connect your Synthflow API credentials
  3. Select "Make a Call" operation
  4. Enter your agent's Model ID
  5. Provide the phone number and recipient name
  6. Configure any optional parameters as needed
  7. Execute the workflow

Example Workflow

Automated Sales Calls:

Trigger (Webhook/Schedule)
  ↓
Get Leads from Database
  ↓
Synthflow Node (Make Call)
  - Model ID: your_agent_id
  - Phone: {{$json["phone"]}}
  - Name: {{$json["name"]}}
  - Custom Variables:
    - product: {{$json["product_name"]}}
    - price: {{$json["price"]}}
  ↓
Log Results

Resources

Version History

0.1.0

  • Initial release
  • Support for "Make a Call" endpoint
  • Full parameter support including custom variables

Development

Build

npm run build

Watch for Changes

npm run dev

Linting

npm run lint
npm run lintfix

Testing

Test the node by installing it in your n8n instance:

# Link the package
npm link

# In your n8n installation directory
npm link @synthflow-ai/n8n-nodes-synthflow

# Restart n8n

License

MIT

Support

For issues, questions, or contributions, please visit the GitHub repository.

For Synthflow-specific questions, contact Synthflow support.

About

Synthflow n8n Node

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Contributors 2

  •  
  •