GateKit icon

GateKit

Universal messaging gateway - send messages across multiple platforms

Actions26

Overview

This node interacts with the GateKit universal messaging gateway API to retrieve a QR code for WhatsApp authentication on a specified platform within a project. It is useful when you need to authenticate or link a WhatsApp platform integration by scanning a QR code, typically during the setup or re-authentication process of the WhatsApp platform in your messaging gateway.

Practical examples include:

  • Automating the retrieval of the WhatsApp QR code to display it in a user interface for scanning.
  • Integrating WhatsApp authentication steps into an automated workflow.
  • Refreshing the QR code periodically if the session expires and re-authentication is required.

Properties

Name Meaning
WhatsApp Platform ID (id) The unique identifier of the WhatsApp platform configuration for which to get the QR code.
Project Slug The identifier (slug) of the project that contains the WhatsApp platform integration.
Id Same as WhatsApp Platform ID; the platform's unique id parameter.

Note: The properties "WhatsApp Platform ID" and "Id" both represent the platform's unique identifier and are required.

Output

The node outputs JSON data containing the QR code information for WhatsApp authentication. This typically includes a URL or base64 encoded image data representing the QR code that can be displayed or processed further.

No binary data output is indicated for this operation.

Dependencies

  • Requires an active GateKit API key credential configured in n8n with appropriate permissions.
  • The node makes HTTP GET requests to the GateKit API endpoint corresponding to the project's WhatsApp platform QR code URL.
  • Requires the "Project Slug" and "WhatsApp Platform ID" to correctly target the API resource.

Troubleshooting

  • Invalid or missing platform ID: Ensure the WhatsApp Platform ID provided is correct and corresponds to an existing platform in the specified project.
  • Authentication errors: Verify that the API key credential is valid and has permissions to access the project's platforms.
  • Project slug errors: Confirm the project slug matches an existing project in GateKit.
  • Network or API errors: Check network connectivity and GateKit API status.
  • Empty or malformed QR code response: This might indicate the platform is not properly configured or not in a state to generate a QR code; verify platform status in GateKit dashboard.

Links and References

Discussion