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, update, list, and unregister webhooks with the OneTap API. It is designed to manage webhook integrations that notify your n8n workflows when specific events occur in the OneTap system, such as participant check-ins or profile updates.

Common scenarios include:

  • Automatically triggering workflows when a participant checks in or out.
  • Syncing new participant or profile data into other systems.
  • Managing webhook subscriptions dynamically from within n8n.

For example, you can register a webhook URL that listens for "Participant Check-In" events, so whenever a participant checks in, OneTap calls your webhook URL, triggering an n8n workflow to process the event.

Properties

Name Meaning
Environment Select which OneTap environment to use: Production (live API server) or Staging (development/testing API server).
Webhook URL The URL that OneTap should call when the subscribed events occur. This is typically your n8n webhook endpoint.
Events The list of events that will trigger the webhook. Options include participant check-in/out, new participant/profile/list creation, updates, deletions, passport events, or all events via wildcard *.
Additional Settings Optional settings for the webhook:
- Webhook Name: Identifier name for the webhook.
- Description: Description of the webhook's purpose.
- Active: Whether the webhook is active.
- Secret: Secret token for verifying webhook signatures.
Integration ID The ID of the existing webhook integration to update or unregister. Required for update and unregister operations.
Operation The action to perform: Register Webhook, Unregister Webhook, List Webhooks, or Update Webhook.

Output

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

  • For Register Webhook and Update Webhook:

    • success: Boolean indicating if the operation succeeded.
    • operation: The operation performed (register or update).
    • environment: The selected environment.
    • integrationId: The unique ID of the webhook integration.
    • apiKey: The API key associated with the integration (only on registration).
    • webhookUrl: The registered webhook URL.
    • events: The list of subscribed events.
    • Additional data returned by the OneTap API about the integration.

  • For Unregister Webhook:

    • success: Boolean indicating success.
    • operation: unregister.
    • environment: The selected environment.
    • integrationId: The ID of the unregistered webhook.
    • Additional response data from the API.

  • For List Webhooks:

    • Each webhook integration is output as a separate item with details including operation, environment, and all properties returned by the API.

If the node encounters errors and is set to continue on fail, it outputs an object with success: false, the error message, and the operation attempted.

Dependencies

  • Requires an API authentication credential for OneTap (an API key or token configured in n8n credentials).
  • Uses HTTP requests to OneTap's API endpoints, which differ based on the selected environment:
    • Production: https://api-beta.onetapcheckin.com
    • Staging: http://localhost:1337 (typically for local development)
  • No additional external dependencies beyond standard n8n HTTP request helpers.

Troubleshooting

  • Common issues:

    • Invalid or missing API credentials will cause authentication failures.
    • Incorrect webhook URLs may lead to failed registrations or unreachable webhook endpoints.
    • Using an invalid or non-existent Integration ID for update/unregister operations will cause errors.
    • Network connectivity issues to the OneTap API server.

  • Error messages:

    • Errors during HTTP requests will be thrown with descriptive messages like "Failed to register webhook with OneTap: [error detail]".
    • If "continue on fail" is enabled, errors are returned as part of the output JSON with success: false.

  • Resolutions:

    • Verify API credentials are correctly configured and valid.
    • Ensure webhook URLs are publicly accessible and correctly formatted.
    • Double-check Integration IDs before updating or unregistering.
    • Confirm network access to the chosen OneTap environment endpoint.

Links and References

Discussion