GateKit icon

GateKit

Universal messaging gateway - send messages across multiple platforms

Overview

The "Get" operation for the "Platforms" resource in this node allows users to retrieve detailed configuration information about a specific platform integration within a project. This is useful when you want to fetch the current settings, credentials, and status of a particular platform instance that has been configured in your messaging gateway system.

Typical use cases include:

  • Inspecting platform details before sending messages or performing other operations.
  • Verifying platform configuration for troubleshooting or auditing.
  • Dynamically retrieving platform info to drive conditional logic in workflows.

For example, if you have integrated a Telegram platform into your project, you can use this operation to get its configuration details by specifying the platform ID and project identifier.

Properties

Name Meaning
Platform ID The unique identifier of the platform configuration you want to retrieve.
Project The project identifier under which the platform is configured. Defaults to "default".
Id Alias for Platform ID; the unique identifier parameter for the platform to get details.

Note: Both "Platform ID" and "Id" refer to the same required string parameter identifying the platform.

Output

The output JSON contains the detailed configuration data of the specified platform. This typically includes fields such as:

  • Platform type (e.g., discord, telegram, whatsapp-evo)
  • Friendly name and description
  • Credentials object with platform-specific authentication details
  • Status flags like whether the platform is active or in test mode
  • Other metadata related to the platform configuration

No binary data output is involved in this operation.

Dependencies

  • Requires an API key credential for authenticating requests to the messaging gateway API.
  • The node uses the base URL from the provided API credentials to make HTTP GET requests.
  • The project identifier must be valid and accessible with the given credentials.

Troubleshooting

  • Missing or invalid Platform ID: Ensure the platform ID is correctly specified and exists in the project.
  • Unauthorized errors: Verify that the API key credential has sufficient permissions to access platform configurations.
  • Project not found: Confirm the project identifier is correct and the user has access rights.
  • Network issues: Check connectivity to the API endpoint defined in the credentials.

Common error messages will relate to HTTP status codes such as 401 Unauthorized, 404 Not Found (invalid platform or project), or 400 Bad Request (missing parameters).

Links and References

Discussion