Actions26
Overview
This node operation allows you to create a new platform integration within a specified project in the GateKit messaging gateway system. It supports configuring platforms such as Discord, Telegram, and WhatsApp Evo by providing necessary credentials and settings. This is useful for users who want to enable multi-platform messaging capabilities in their projects, allowing them to send and receive messages across different communication channels seamlessly.
Practical examples include:
- Adding a Telegram bot integration to a project to send notifications.
- Configuring a Discord server connection to manage community messages.
- Setting up WhatsApp Evo for customer support messaging.
Properties
| Name | Meaning |
|---|---|
| Platform type | The type of platform to configure. Options: discord, telegram, whatsapp-evo. |
| Platform credentials (JSON object) | JSON object containing the required authentication and configuration fields specific to the chosen platform. Use the command "gatekit platforms supported" to see exact requirements per platform. |
| Enable platform | Boolean flag to activate or deactivate the platform integration. Default is true (enabled). |
| Enable test mode | Boolean flag to enable or disable test mode for the platform integration. |
| Project Slug | Identifier slug of the project where the platform will be configured. |
Output
The output of this operation is the JSON response from the GateKit API after creating the platform integration. This typically includes details about the newly created platform configuration such as its ID, status, and any metadata returned by the API.
No binary data output is involved in this operation.
Dependencies
- Requires an active GateKit API key credential with appropriate permissions.
- The node uses the GateKit API base URL and authentication headers configured via credentials.
- The project identified by the provided Project Slug must exist in GateKit.
Troubleshooting
- Invalid credentials error: Ensure that the JSON credentials object matches the required format and contains valid authentication tokens or keys for the selected platform.
- Project not found: Verify that the Project Slug corresponds to an existing project in your GateKit account.
- Platform type unsupported: Confirm that the platform type is one of the supported options (
discord,telegram,whatsapp-evo). - API connectivity issues: Check network connectivity and that the API URL and key are correctly configured in the node credentials.
- Missing required fields: Make sure all required properties, especially
platform,credentials, andprojectSlug, are provided.