Overview
This node acts as a trigger for workflows based on events occurring within a GateKit project. It listens for specific message-related events such as when messages are received, sent, failed, or when users interact with messages via buttons or reactions. When one of the subscribed events happens in the specified GateKit project, the node activates the workflow.
Common scenarios include:
- Automating responses or logging when new messages arrive.
- Tracking message delivery status to update CRM or support systems.
- Reacting to user interactions like button clicks or reactions to tailor user experience or gather feedback.
For example, you could use this node to trigger a workflow that sends a notification whenever a message fails to send, allowing your team to quickly address communication issues.
Properties
| Name | Meaning |
|---|---|
| Project ID | The GateKit project ID to monitor for messages. |
| Events | The types of events to subscribe to. Options include: |
| - Message Received: Trigger when a message is received. | |
| - Message Sent: Trigger when a message is sent successfully. | |
| - Message Failed: Trigger when a message fails to send. | |
| - Button Clicked: Trigger when a button is clicked. | |
| - Reaction Added: Trigger when a reaction is added to a message. | |
| - Reaction Removed: Trigger when a reaction is removed from a message. | |
| Webhook Name | A name to identify this webhook in the GateKit dashboard. |
Output
The node outputs JSON data representing the event payload received from GateKit. This includes detailed information about the event type and associated message or interaction data.
The output structure is an array containing one object per event, with all relevant event details as provided by GateKit's webhook payload.
No binary data output is produced by this node.
Dependencies
- Requires an API key credential for authenticating with the GateKit API.
- Needs a publicly accessible webhook URL (cannot run on localhost without tunneling).
- Relies on GateKit's webhook infrastructure to deliver event notifications.
Troubleshooting
- Webhook creation errors: If the webhook cannot be created, ensure the Project ID is correct and the webhook URL is publicly accessible (not localhost).
- Missing signature or timestamp: Incoming webhook requests must include valid security headers; otherwise, the node will reject them to prevent unauthorized access.
- Invalid webhook signature: Indicates possible tampering or misconfiguration of the webhook secret. Verify the webhook secret stored matches the one in GateKit.
- API request failures: Check that the API key credential is valid and has sufficient permissions.
- Event subscription issues: Ensure at least one event type is selected; otherwise, no triggers will occur.