GateKit icon

GateKit

Universal messaging gateway - send messages across multiple platforms

Overview

This node allows you to create a new platform integration within the GateKit messaging gateway system. It is designed to configure and register various messaging platforms such as Discord, Telegram, or WhatsApp (via Evo). By creating a platform instance, you enable your project to send and receive messages through that platform using GateKit's unified API.

Common scenarios include:

  • Setting up a new messaging channel for customer support or community engagement.
  • Integrating multiple chat platforms into a single workflow.
  • Automating message sending and receiving across different platforms without handling each platform's API separately.

For example, you can create a Telegram platform instance by providing its credentials and a friendly name, enabling your project to send notifications or respond to user messages on Telegram.

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 this platform configuration in your project.
Optional description for the platform instance Additional descriptive text about the platform instance (optional).
Platform credentials (JSON object) JSON object containing the required authentication details for the selected platform. Use the command "gatekit platforms supported" to see required fields per platform.
Enable platform Boolean flag to activate or deactivate the platform instance. Defaults to enabled (true).
Enable test mode Boolean flag to enable test mode for the platform instance (optional).
Project Identifier of the project under which this platform instance will be created.

Output

The node outputs the JSON response from the GateKit API after creating the platform instance. This typically includes details about the newly created platform configuration such as its ID, status, and metadata.

No binary data output is involved.

Dependencies

  • Requires an API key credential for authenticating with the GateKit API.
  • The node uses the GateKit API base URL configured in the credentials.
  • The project identifier must be specified to scope the platform creation.

Troubleshooting

  • Invalid credentials error: Ensure the JSON credentials provided match the requirements for the selected platform type. Use the "gatekit platforms supported" command to verify required fields.
  • Missing required parameters: The platform type, friendly name, credentials, and project are mandatory. Verify all required inputs are set.
  • API authentication failure: Confirm that the API key credential is valid and has permissions for the target project.
  • Platform already exists: If a platform with the same name or configuration exists, the API may reject the creation. Use unique names or update existing platforms instead.

Links and References

Discussion