GateKit icon

GateKit

Universal messaging gateway - send messages across multiple platforms

Actions26

Overview

The "Messages: Status" operation in the GateKit node allows users to check the delivery status of a previously sent message by querying its job ID within a specified project. This is useful for monitoring message processing and ensuring that messages have been successfully delivered or identifying any issues with message delivery.

Typical use cases include:

  • Verifying if a message sent through multiple platforms (e.g., Telegram, Discord, WhatsApp) has been delivered.
  • Tracking the progress or final state of asynchronous message sending jobs.
  • Integrating message status checks into automated workflows to trigger follow-up actions based on delivery success or failure.

For example, after sending a message via the "Send" operation, you can use the "Status" operation with the returned job ID to confirm whether the message was delivered or if it failed.

Properties

Name Meaning
Message job ID The unique identifier of the message sending job whose status you want to check.
Project Slug The identifier (slug) of the project under which the message job was created.

Note: The property "JobId" appears duplicated but refers to the same concept as "Message job ID".

Output

The output JSON contains the status information of the message job identified by the provided job ID. It typically includes details such as:

  • Current delivery status (e.g., pending, sent, failed).
  • Timestamps related to the job lifecycle.
  • Any error messages or failure reasons if applicable.
  • Possibly platform-specific delivery details.

This output enables users to programmatically assess the outcome of message delivery attempts.

The node does not explicitly handle binary data for this operation.

Dependencies

  • Requires an API key credential configured in n8n to authenticate requests to the GateKit messaging gateway API.
  • The node sends HTTP GET requests to the endpoint /api/v1/projects/{projectSlug}/messages/status/{jobId}.
  • The projectSlug must correspond to an existing project in the GateKit system.
  • Proper network connectivity to the GateKit API base URL is necessary.

Troubleshooting

  • Invalid or missing job ID: If the job ID is incorrect or not found, the API may return an error indicating the job does not exist. Verify the job ID value.
  • Unauthorized access: Missing or invalid API credentials will cause authentication errors. Ensure the API key credential is correctly set up.
  • Incorrect project slug: Using a non-existent or misspelled project slug will result in resource not found errors.
  • Network issues: Connectivity problems to the GateKit API endpoint will cause request failures.
  • API rate limits: Excessive requests might be throttled; consider adding delays or retries.

To resolve these issues, verify all input parameters, ensure valid credentials, and check network connectivity.

Links and References

  • GateKit API Documentation (hypothetical link for reference)
  • n8n documentation on HTTP Request Node for understanding underlying request mechanics
  • Messaging platform integration guides relevant to your project setup

Discussion