OneTap Webhook Manager icon

OneTap Webhook Manager

Register and manage webhooks with OneTap
Join our community

Actions4

Overview

The OneTap Webhook Manager node allows users to register, unregister, list, and update webhooks with the OneTap API. It is designed to manage webhook integrations that notify external systems when specific events occur within the OneTap platform.

Common scenarios where this node is beneficial include:

  • Automatically registering a webhook URL to receive event notifications such as participant check-ins or profile updates.
  • Managing existing webhook integrations by updating their settings or deactivating them.
  • Retrieving a list of all registered webhooks for monitoring or auditing purposes.
  • Removing obsolete or unwanted webhook registrations.

Practical example: A user can configure this node to register a webhook that triggers whenever a new participant checks in at an event, enabling real-time processing of attendance data in n8n workflows.

Properties

Name Meaning
Environment Select which OneTap environment to use: Production (live API server) or Staging (development server).
Operation Choose the action to perform: Register Webhook, Unregister Webhook, List Webhooks, or Update Webhook.
Webhook URL The URL that OneTap should call when events occur. Required for Register and Update operations.
Events List of events that trigger the webhook. Options include participant check-in/out, profile created/updated/deleted, list created/updated/deleted, passport created/deleted, or all events via wildcard *. Required for Register and Update operations.
Additional Settings Collection of optional settings for the webhook:
- Webhook Name: Identifier name for the webhook.
- Description: Purpose description.
- Active: Boolean to activate/deactivate the webhook.
- Secret: Optional secret string used for webhook signature verification.
Integration ID The ID of the integration to unregister or update. Required for Unregister and Update operations.

Output

The node outputs JSON objects representing the result of the performed operation:

  • Register Webhook: Returns success status, operation type, environment, integration ID, API key, webhook URL, subscribed events, and other webhook details.
  • Unregister Webhook: Returns success status, operation type, environment, integration ID, and response from the delete request.
  • List Webhooks: Returns each registered webhook's details including operation type, environment, and webhook properties.
  • Update Webhook: Returns success status, operation type, environment, integration ID, and updated webhook details.

If multiple items are processed, the output contains one JSON object per item. Each output includes a pairedItem index linking it to the input.

The node does not output binary data.

Dependencies

  • Requires an API authentication credential for OneTap (an API key or token).
  • Uses HTTP requests to communicate with OneTap API endpoints.
  • Supports two environments: production (https://api-beta.onetapcheckin.com) and staging (http://localhost:1337).

No additional external dependencies are required beyond the configured API credential.

Troubleshooting

  • Common issues:

    • Invalid or missing API credentials will cause authentication failures.
    • Incorrect Integration ID for unregister or update operations will result in errors indicating the resource was not found.
    • Providing invalid webhook URLs or unsupported event names may cause the API to reject the request.
    • Network connectivity issues to the selected environment endpoint can cause timeouts or connection errors.

  • Error messages:

    • Errors thrown during HTTP requests include descriptive messages from the OneTap API.
    • If continueOnFail is disabled, the node stops execution on the first error; enabling it allows processing remaining items.
    • Error messages typically indicate the failed operation and reason, e.g., "Failed to register webhook with OneTap: [error message]".

  • Resolution tips:

    • Verify API credentials and permissions.
    • Confirm the correctness of the Integration ID.
    • Ensure webhook URLs are reachable and properly formatted.
    • Check network access to the chosen environment endpoint.

Links and References

Discussion