OneTap icon

OneTap

Manage visitors, check-ins, and attendance with OneTap
Join our community

Actions35

Overview

This node integrates with the OneTap API to manage punch passes, which are digital "punch cards" or passes that track check-ins for a profile. The Redeem operation specifically allows you to redeem (use) a punch pass by associating it with a particular check-in event. This is useful in scenarios such as loyalty programs, event attendance tracking, or any system where users consume punches or credits upon check-in.

For example, if you run a coffee shop loyalty program, each customer has a punch pass representing their prepaid coffee punches. When they visit and check in, this node's Redeem operation can be used to mark one punch as redeemed against their pass.

Properties

Name Meaning
Passport ID The unique identifier of the punch pass to redeem.
Check In ID The unique identifier of the check-in event to associate with the punch pass redemption.

Output

The output JSON contains the response from the OneTap API after redeeming the punch pass. It typically includes details about the updated punch pass status, such as remaining punches, redemption confirmation, timestamps, and any related metadata returned by the API.

No binary data output is produced by this operation.

Example output structure (simplified):

{
  "id": "string",                // Punch pass ID
  "profileId": "string",         // Associated profile ID
  "checkIns": [                  // Array of associated check-ins including the redeemed one
    {
      "checkInId": "string",
      "timestamp": "number"
    }
  ],
  "remainingPunches": "number",  // Number of punches left after redemption
  "status": "string"             // Status of the punch pass (e.g., active, redeemed)
}

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.
  • Proper configuration of the OneTap API credentials in n8n is necessary.

Troubleshooting

  • Invalid Passport ID or Check In ID: If either ID is incorrect or does not exist, the API will return an error. Verify IDs before running the node.
  • Authentication Errors: Ensure the API key credential is valid and has sufficient permissions.
  • Network Issues: Connectivity problems may cause request failures; verify network access to the OneTap API.
  • API Rate Limits: Excessive calls might be throttled by the API; consider adding delays or handling rate limit errors gracefully.
  • Error Messages: The node throws errors with messages like Failed to execute punchPasses operation from OneTap API: <error message>. Review the error message for specifics and check the input parameters.

Links and References

Discussion