OneTap

Manage visitors, check-ins, and attendance with OneTap

Actions35

Overview

This node integrates with the OneTap API to manage lists used for visitor management, check-ins, and attendance tracking. Specifically, the "List - Create" operation allows users to create a new list with various configurable properties such as name, date, description, scheduling, and check-in/check-out options.

Common scenarios where this node is beneficial include event management, facility access control, or any situation requiring organized tracking of attendees or participants over time. For example, an event organizer can use this node to create daily or recurring attendance lists with specific check-in methods enabled, facilitating smooth visitor flow and record-keeping.

Properties

Name	Meaning
List Name	The name of the list to be created.
List Date	The date associated with the list (e.g., event date).
Additional Fields	A collection of optional fields to further configure the list:
Description	Text description of the list.
Notes	Additional notes about the list.
End Date	Optional end date for the list.
Time Zone	Time zone identifier (e.g., America/Chicago) for the list's timing context.
Auto Create Child List	Boolean flag indicating whether child lists should be automatically created for recurring lists.
Check Out Enabled	Boolean flag to enable check-out functionality for this list.
Check In Option	Method used for check-in; options include: TAP, QR, Manual, Kiosk, SMS, Email, Voice, Browser, Mobile App.
Check Out Option	Method used for check-out; same options as Check In Option.
Is Open Registration	Boolean flag to enable open registration for the list.
Open Registration Setting	Type of open registration; options are Open, Closed, or Profiles.
Source	Source information describing how or from where the list was created.
Parent ID	Identifier of a parent list if this list is a child in a hierarchy.
Schedule	Recurring schedule configuration specifying which days of the week the list recurs on (Monday through Sunday as booleans).

Output

The node outputs JSON data representing the newly created list as returned by the OneTap API. This typically includes all details of the list such as its unique ID, name, dates, settings, and any other metadata provided by the API response.

No binary data output is involved in this operation.

Example output snippet (simplified):

{
  "id": "list_12345",
  "name": "Weekly Meeting",
  "date": 1686000000,
  "description": "Team weekly sync",
  "timeZone": "America/Chicago",
  "checkInOption": "manual",
  "checkOutEnabled": true,
  "schedule": {
    "monday": true,
    "wednesday": true,
    "friday": true
  }
}

Dependencies

Requires an API key credential for authenticating with the OneTap API.
The node makes HTTP requests to the OneTap API endpoint at https://api-beta.onetapcheckin.com/api/lists.
Proper timezone strings and date formats must be used to avoid errors.
n8n environment must have network access to the OneTap API.

Troubleshooting

Invalid Date Format: If the list date or end date is not properly formatted or cannot be parsed, the API may reject the request. Ensure dates are valid ISO strings or timestamps.
Authentication Errors: Missing or invalid API credentials will cause authentication failures. Verify that the API key credential is correctly configured.
Invalid Option Values: Selecting unsupported values for check-in/check-out options or open registration settings may result in API errors. Use only the documented option values.
API Rate Limits: Excessive requests might trigger rate limiting. Implement retries or delays if needed.
Network Issues: Connectivity problems to the OneTap API endpoint will cause request failures. Check network/firewall settings.

Error messages from the node will include the API error message and indicate the failed operation for easier debugging.

Links and References

OneTap API Documentation (general reference for API endpoints and parameters)
n8n HTTP Request Node Documentation (for understanding HTTP request handling in n8n)
Time Zone Database (for valid timezone identifiers)

This summary covers the "List - Create" operation of the OneTap node based on static analysis of the source code and provided property definitions.

OneTapInstall