GateKit icon

GateKit

Universal messaging gateway - send messages across multiple platforms

Actions51

Overview

This node operation allows you to create a new webhook for event notifications within a specified project. Webhooks are HTTP callbacks that notify your system when certain events occur, enabling real-time integration and automation. This is particularly useful for scenarios where you want to react immediately to messaging events such as message receipt, sending, failures, button clicks, or reactions on messages.

Practical examples include:

  • Automatically triggering workflows when a new message is received.
  • Logging message delivery statuses by subscribing to sent or failed message events.
  • Responding to user interactions like button clicks or emoji reactions in chat platforms.

Properties

Name Meaning
Friendly name for the webhook (name) A user-friendly identifier for the webhook to easily recognize it.
Target URL for webhook delivery (url) The destination URL where webhook event notifications will be sent via HTTP POST requests.
Events to subscribe to (events) Comma-separated list of event types to listen for. Options: message.received, message.sent, message.failed, button.clicked, reaction.added, reaction.removed.
Custom webhook secret (secret) Optional secret string used to secure webhook payloads; if not provided, one will be auto-generated.
Project (project) Identifier of the project under which the webhook will be created.

Output

The node outputs JSON data representing the newly created webhook object returned from the API. This typically includes details such as the webhook ID, name, subscribed events, target URL, secret, status, and metadata related to the webhook configuration.

There is no indication that this node outputs binary data.

Dependencies

  • Requires an API key credential configured in n8n to authenticate with the GateKit API.
  • The node makes a POST request to the endpoint /api/v1/projects/{project}/webhooks to create the webhook.
  • The project parameter must correspond to an existing project identifier in the GateKit system.

Troubleshooting

  • Invalid or missing project ID: Ensure the project property is correctly set to a valid project identifier.
  • Invalid URL format: The url property must be a valid and reachable HTTP(S) endpoint.
  • Event subscription errors: The events property must contain valid event names separated by commas without typos.
  • Authentication errors: Verify that the API key credential is properly configured and has permissions to create webhooks.
  • Secret conflicts: If providing a custom secret, ensure it meets any length or character requirements imposed by the API.

Common error messages might include HTTP 400 for bad requests (e.g., invalid parameters), 401 for unauthorized access (invalid credentials), or 404 if the project does not exist.

Links and References

Discussion