OneTap icon

OneTap

Manage visitors, check-ins, and attendance with OneTap

Overview

The "Check In" operation for the Participant resource in this OneTap node allows you to check in a participant to an event or list using various optional metadata such as method, location, time zone, and source. This operation is useful in scenarios where you want to track attendance or visitor presence in real-time, such as conferences, workshops, or any event requiring participant management.

Practical examples include:

  • Automatically checking in participants when they arrive at an event via scanning a QR code or tapping a device.
  • Manually checking in participants through a kiosk or admin interface.
  • Recording GPS coordinates and time zone information during check-in for auditing or analytics.
  • Sending visitor alerts upon check-in if enabled.

Properties

Name Meaning
Participant ID The unique identifier of the participant to check in (required).
Check-in/Check-Out Fields (collection) Additional optional fields to specify details about the check-in:
- List ID Identifier of the list associated with the check-in.
- Profile ID Identifier of the profile associated with the participant.
- Method The method used for check-in. Options: TAP, QR, Manual, Kiosk, SMS, Email, Voice, Browser, Mobile App. Default is MANUAL.
- Source Source description of the check-in (e.g., API, mobile app).
- Location GPS coordinates of the check-in location, including Latitude and Longitude.
- Time Zone Time zone string for the check-in time (e.g., America/Chicago).
- Installation ID Identifier for the installation or device performing the check-in.
- Send Visitor Alert Boolean flag indicating whether to send a visitor alert notification upon check-in.

Output

The output JSON contains the response from the OneTap API after performing the check-in. It typically includes details about the participant's updated status, timestamps, and any metadata related to the check-in.

Example structure (simplified):

{
  "id": "participant-id",
  "checkedIn": true,
  "checkInDate": 1680000000,
  "checkInMethod": "MANUAL",
  "location": {
    "lat": 41.8781,
    "lng": -87.6298
  },
  "source": "API",
  "sendVisitorAlert": false,
  ...
}

No binary data output is produced by this operation.

Dependencies

  • Requires an API key credential configured in n8n for authenticating requests to the OneTap API.
  • The node makes HTTP POST requests to the endpoint:
    https://api-beta.onetapcheckin.com/api/participants/{participantId}/checkin
  • Proper network connectivity to the OneTap API service is required.

Troubleshooting

  • Common issues:

    • Invalid or missing Participant ID will cause the API to reject the request.
    • Incorrect or expired API credentials will result in authentication errors.
    • Providing invalid GPS coordinates or malformed time zone strings may cause validation errors.
    • Network connectivity problems can lead to request timeouts or failures.
  • Error messages:

    • "Failed to execute participants operation from OneTap API: <error message>" indicates an error returned by the API or network failure.
    • Authentication errors usually mention unauthorized access or invalid token.
    • Validation errors will specify which input field is incorrect or missing.
  • Resolutions:

    • Ensure the Participant ID is correct and exists in the OneTap system.
    • Verify that the API key credential is valid and has necessary permissions.
    • Double-check the format of optional fields like GPS coordinates and time zones.
    • Confirm network access to the OneTap API endpoint.

Links and References


This summary focuses on the Participant resource's Check In operation as requested, based on static analysis of the provided source code and property definitions.

Discussion