GateKit icon

GateKit

Universal messaging gateway - send messages across multiple platforms

Overview

This node interacts with the GateKit API to manage webhook delivery attempts for a specified project and webhook. Specifically, the "Deliveries" operation under the "Webhooks" resource lists webhook delivery attempts, allowing filtering by event type and delivery status, as well as pagination controls.

Use cases include:

  • Monitoring webhook delivery attempts to ensure notifications are being sent successfully.
  • Filtering deliveries by event type (e.g., message.received) or status (pending, success, failed) to diagnose issues.
  • Paginating through large sets of delivery records for auditing or reporting purposes.

Example: Retrieve the last 50 successful webhook deliveries for a specific webhook in your project to verify that events are being delivered correctly.

Properties

Name Meaning
Webhook ID The unique identifier of the webhook whose deliveries you want to list.
Filter by event type Optional filter to only include deliveries for a specific event type (e.g., message.sent).
Filter by delivery status Optional filter to include deliveries by their status: pending, success, or failed.
Number of deliveries to return (1-100) Limits the number of delivery records returned; default is 50.
Number of deliveries to skip Number of delivery records to skip for pagination purposes.
Project Identifier of the project to operate on; required to specify the context for the webhook.

Output

The node outputs JSON data representing the list of webhook delivery attempts matching the specified filters. Each item typically includes details about individual delivery attempts such as timestamps, event types, status, and possibly error information if a delivery failed.

No binary data output is indicated for this operation.

Dependencies

  • Requires an API key credential for authenticating with the GateKit API.
  • The node expects the base URL for the API to be configured via credentials.
  • Proper project and webhook identifiers must be provided to access the relevant data.

Troubleshooting

  • Invalid Webhook ID: If the webhook ID does not exist or is incorrect, the API will likely return an error indicating the webhook was not found. Verify the webhook ID is correct.
  • Authentication Errors: Missing or invalid API key credentials will cause authentication failures. Ensure valid credentials are configured.
  • Permission Denied: Accessing a project or webhook without sufficient permissions may result in authorization errors. Confirm your API key has appropriate scopes.
  • Pagination Issues: Setting limit or offset values outside allowed ranges (e.g., limit > 100) may cause errors or unexpected results. Use values within documented limits.
  • Empty Results: If no deliveries match the filters, the output will be empty. Try adjusting filters or verifying that deliveries exist.

Links and References


Note: This summary is based solely on static analysis of the node's properties and routing configuration for the "webhooks" resource and "deliveries" operation.

Discussion