Package Information
Released: 12 mo ago
Downloads: 6 weekly / 51 monthly
Latest Version: 0.1.0
Author: samyek sonawane
Available Nodes
Documentation
n8n-nodes-platform
This package contains n8n nodes for integrating with the Platform API.
Installation
In n8n:
- Go to Settings > Community Nodes
- Select Install
- Enter
n8n-nodes-platformin Enter npm package name - Click Install
Manual installation:
npm install n8n-nodes-platform
Credentials
To use the Platform nodes, you need to create credentials with your Platform API key.
- Go to Credentials in n8n
- Click Create New
- Search for "Platform API"
- Enter your API key and base URL
Nodes
Platform
This node allows you to interact with various Platform resources:
Messaging
- Send Message: Send a message to a user
- Get Messages: Get messages from a conversation
CRM
- Get Contact: Get a contact by ID
- Create Contact: Create a new contact
- Update Contact: Update an existing contact
Bot
- Get Bot: Get a bot by ID
- Trigger Bot: Trigger a bot workflow
Automation
- Get Automation: Get an automation by ID
- Trigger Automation: Trigger an automation workflow
Ecommerce
- Get Product: Get a product by ID
- Create Order: Create a new order
Example Usage
Send a Message
- Add a Platform node
- Select Messaging as the resource
- Select Send Message as the operation
- Enter the recipient ID and message text
- Execute the node
Create a Contact
- Add a Platform node
- Select CRM as the resource
- Select Create Contact as the operation
- Enter the contact data in JSON format
- Execute the node
Trigger an Automation
- Add a Platform node
- Select Automation as the resource
- Select Trigger Automation as the operation
- Enter the automation ID
- Enter the trigger data in JSON format
- Execute the node
Development
- Clone the repository
- Install dependencies:
npm install - Build the package:
npm run build - Link to n8n:
npm link - In your n8n installation directory:
npm link n8n-nodes-platform
License
MIT