OneTap has an open API so you can integrate with 3rd party forms.
Things you can use the API for:
- Create participants/guests on OneTap from 3rd party registration forms.
- Create profiles on OneTap from 3rd party registration forms.
- Check-in participants/guests on OneTap.
- Integrate OneTap with other products.
Register Participants/Guests using the API
Goal: Add a participant/guest into a specific list on OneTap using our API.
Step 1 - copy this text below:
Step 2 - Add the following text snippets to the previous URL text:
⚠️ Replace the CHANGE_THIS subtext with your API Key
How do I find my List ID?
⚠️ Replace the CHANGE_THIS subtext with your List ID
⚠️ Replace the CHANGE_THIS subtext with your Account ID
Step 3 - The final URL should look like this:
Step 4 - Plug in this URL into your 3rd party form.
You should receive the following response from our server:
You can send the following fields (JSON keys) inside the data payload:
avatar (or avatar url, picture)
ℹ️Note: Any other fields send over are saved as custom fields on our system.
Custom Field Examples:
Testing & Debugging
Simple Test (Browser)
Step 1 - Change the endpoint from '/register' to '/test', the final URL should look like this:
Step 2 - Paste this into your chrome browser URL and press enter
Paste the HTML page content into this tool.
Step 3 - You should see a message like this:
"message": "you are authenticated as firstname.lastname@example.org under ORGANIZATION_NAME"
Follow the instructions on this screenshot:
- Change the HTTP method from 'GET' to 'POST'
- Paste the full URL (see below)
- Paste some data (see below)
"name": "Testing OneTap API",
"address": "1 OneTap Ave",
"notes": "Edit me"