Actions52
- ApiKeys Actions
- Auth Actions
- Identities Actions
- Members Actions
- Messages Actions
- Platform Logs Actions
- Platforms Actions
- Projects Actions
- Webhooks Actions
Overview
The "Platforms - Create" operation in this node allows users to configure a new platform integration within a messaging gateway system. This enables sending and receiving messages across multiple platforms such as Discord, Telegram, and WhatsApp Evo by setting up platform instances with specific credentials and settings.
Common scenarios where this node is beneficial include:
- Integrating a new messaging platform into an existing multi-platform messaging workflow.
- Automating the setup of platform connections for projects that require communication over different chat services.
- Managing platform configurations programmatically as part of a larger automation or deployment pipeline.
For example, a user can create a new Telegram platform instance by providing its type, friendly name, credentials, and optional description, enabling message routing through Telegram channels.
Properties
| Name | Meaning |
|---|---|
| Platform type | The type of messaging platform to integrate. Options: discord, telegram, whatsapp-evo. |
| Friendly name for the platform instance | A human-readable name to identify the platform instance. |
| Optional description for the platform instance | Additional descriptive text about the platform instance (optional). |
| Platform credentials (JSON object) | JSON object containing authentication details required by the selected platform. Use external command msgcore platforms supported to see required fields per platform. |
| Enable platform | Boolean flag to enable (true) or disable (false) the platform instance. Defaults to enabled. |
| Enable test mode | Boolean flag to enable test mode for the platform instance (optional). |
| Project | Identifier of the project under which the platform instance will be created. |
Output
The output of this operation is the JSON response from the API after creating the platform configuration. It typically includes details about the newly created platform instance such as its ID, type, name, status, and other metadata.
No binary data output is involved in this operation.
Dependencies
- Requires an API key credential configured in n8n to authenticate requests against the messaging gateway API.
- The node sends HTTP POST requests to the endpoint
/api/v1/projects/{project}/platformswith the provided parameters. - The user must supply valid platform credentials in JSON format appropriate for the chosen platform type.
Troubleshooting
- Invalid Credentials: If the platform credentials JSON is malformed or missing required fields, the API may reject the request. Verify credentials using the external command
msgcore platforms supported. - Missing Required Fields: Ensure all required properties (
platform,name,credentials,project) are provided; otherwise, the API will return validation errors. - API Authentication Errors: Confirm that the API key credential is correctly set up and has permissions to create platform configurations.
- Project Not Found: Using an incorrect or non-existent project identifier will cause the API to fail. Verify the project exists.
- Platform Type Unsupported: Only the listed platform types (
discord,telegram,whatsapp-evo) are accepted. Using others will result in errors.
Links and References
- Messaging Gateway API Documentation (generic): Refer to your service's official API docs for detailed platform credential requirements and platform management endpoints.
msgcore platforms supportedcommand: Use this CLI command or equivalent API call to retrieve supported platforms and their credential schemas.