OneTapInstall

Overview

This node integrates with the OneTap API to manage visitor profiles, check-ins, attendance, and related entities such as passports, punch passes, participants, and lists. Specifically, the "Find by Check-in Code" operation under the "Profile" resource allows users to retrieve a visitor profile using a unique check-in code.

Common scenarios for this node include:

• Retrieving visitor information quickly at an event or venue by scanning or entering their check-in code.
• Automating workflows that require fetching profile details based on check-in codes for attendance tracking or access control.
• Integrating visitor management systems with other tools by syncing profile data via check-in codes.

Practical example:

• An event organizer uses this node to find a visitor's profile when they arrive by inputting their check-in code scanned from a badge or QR code, enabling quick verification and check-in confirmation.

Properties

Output

The node outputs JSON data representing the visitor profile associated with the provided check-in code. The structure typically includes all profile details returned by the OneTap API, such as name, email, phone, address, notes, favorite status, custom fields, and other metadata related to the visitor.

No binary data output is involved in this operation.

Example output snippet (simplified):

{
  "id": "profile_id",
  "name": "John Doe",
  "email": "john@example.com",
  "phone": "1234567890",
  "checkInCode": "JD001",
  "customFields": {
    "employeeId": "EMP001"
  },
  ...
}

Dependencies

• Requires an API key credential for authenticating requests to the OneTap API.
• The node makes HTTP GET requests to the endpoint: https://api-beta.onetapcheckin.com/api/profiles/checkInCode.
• No additional external dependencies are required beyond the configured API authentication.

Troubleshooting

• Common issues:

  • Providing an invalid or non-existent check-in code will result in no profile found or an error response.
  • Network connectivity problems or incorrect API credentials can cause request failures.
  • Rate limiting or API quota exceeded errors if too many requests are made in a short time.

• Error messages:

  • Errors from the OneTap API will be surfaced with descriptive messages indicating the failure reason.
  • If the node fails due to an exception, it will throw an error specifying the failed resource and operation, e.g., "Failed to execute profile operation from OneTap API: [error message]".

• Resolution tips:

  • Verify the check-in code is correct and exists in the OneTap system.
  • Ensure the API key credential is valid and has necessary permissions.
  • Check network connectivity and retry after some time if rate limits are hit.
  • Enable "Continue On Fail" option in the node settings to handle errors gracefully within workflows.

Links and References

• OneTap API Documentation (general reference for API endpoints and usage)
• n8n documentation on HTTP Request Authentication for setting up API credentials