GateKit icon

GateKit

Universal messaging gateway - send messages across multiple platforms

Overview

This node enables sending messages across multiple messaging platforms through a universal messaging gateway. It is designed to facilitate communication by allowing users to send text or rich content messages to one or more targets identified by platform-specific identifiers. This node is beneficial in scenarios where you want to automate notifications, alerts, or any form of messaging that needs to be delivered to users on different platforms such as Telegram, Discord, WhatsApp, and others supported by the gateway.

Practical examples include:

  • Sending a notification message to a specific user on Telegram.
  • Broadcasting an announcement to multiple users across different platforms simultaneously.
  • Sending complex message content with metadata and options for advanced formatting or delivery preferences.

Properties

Name Meaning
target Single target identifier in the format platformId:type:id specifying where to send message.
targets Multiple target identifiers, comma-separated, each in the format platformId:type:id.
text The plain text content of the message to send.
content Full message content object in JSON format for advanced message structures.
options JSON object containing additional message options (e.g., delivery preferences).
metadata JSON object containing metadata related to the message.
project Identifier of the project context under which the message is sent (required).

Output

The output contains a JSON object representing the response from the messaging gateway after attempting to send the message(s). This typically includes details about the message job, status, and any relevant identifiers or error information returned by the API.

If the node supports binary data output (not explicitly shown here), it would represent attachments or media sent along with the message, but this node primarily deals with JSON message content.

Dependencies

  • Requires an API key credential for authentication with the messaging gateway service.
  • Needs the base URL of the messaging gateway API configured in the credentials.
  • The node sends HTTP POST requests to the /api/v1/projects/{project}/messages/send endpoint of the gateway.

Troubleshooting

  • Missing or invalid project ID: Ensure the "Project" property is set correctly; otherwise, the API will reject the request.
  • Invalid target format: Targets must follow the platformId:type:id format; incorrect formatting will cause errors.
  • Empty message content: Either text or content should be provided; sending empty messages may result in failure.
  • Authentication errors: Verify that the API key credential is valid and has appropriate permissions.
  • API connectivity issues: Check network access to the configured API URL and ensure the gateway service is operational.

Common error messages:

  • Unauthorized or 401 errors indicate invalid or missing API credentials.
  • 400 Bad Request errors often relate to malformed input parameters like targets or message content.
  • 404 Not Found may indicate an invalid project or endpoint.

Links and References

  • GateKit Messaging Gateway Documentation (hypothetical link as no direct link provided)
  • Refer to your messaging platform's API documentation for target identifier formats and message content structure.

Discussion