<aside> ✔️ We offer both Zapier and webhooks to fully integrate with your waitlist.

</aside>

How to setup

Please email Bani ([email protected]) your webhook URL.

How does it work

Every time a user (1) signs up for your waitlist or (2) gets offboarded from your WaitlistAPI dashboard, we send a POST request to your webhook URL with data about the user. The data is specified below and returned as a JSON.

When a new waiter signs up

event [string]: When a new user signs up, the event will always be new_waiter

waiter_id [string]: Every user is assigned a unique ID

waiter_email [string]: The email of the user that signed up

waiter_priority [integer]: Their current priority in the waitlist

waiter_referral_bool [boolean]: Whether the user has been referred by another user

waiter_created [string]: Date of when a user signs up, formatted %Y-%m-%d %H:%M

waiter_amount_referred [integer]: The amount of other users the user has referred

waiter_referral_token [string]: Every user has a unique referral token used to identify referrals.

waiter_referred_by_token [string]: If this user is referred by another user, we store the referral token of the user who originally referred for backtracking purposes.

"event": "new_waiter",
"waiter_id": 12,
"waiter_email": "[email protected]",
"waiter_priority": 42379,
"waiter_referral_bool": TRUE,
"waiter_created": "%Y-%m-%d %H:%M",
"waiter_amount_referred": 0,
"waiter_referral_token": "13Aeh7A",
"waiter_referred_by_token": "hd8Adn9"

When a user is offboarded from your waitlist dashboard

event [string]: When a new user signs up, the event will always be offboarded_waiter

waiter_id [string]: Every user is assigned a unique ID

waiter_email [string]: The email of the user that signed up

waiter_priority_upon_offboarding [integer]: The users priority in waitlist when they are offboarded

waiter_referral_bool [boolean]: Whether the user was referred by another user when they first signed up

waiter_created [string]: Date of when the user first signed up, formatted %Y-%m-%d %H:%M

waiter_removed [string]: Date of when the user was offboarded formatted %Y-%m-%d %H:%M

waiter_amount_referred [integer]: The amount of other users the user has referred during the time that they weren't offboarded

waiter_referral_token [string]: Every user has a unique referral token used to identify referrals.

waiter_referred_by_token [string]: If this user is referred by another user, we store the referral token of the user who originally referred for backtracking purposes.

"event": "offboarded_waiter",
"waiter_id": 12,
"waiter_email": "[email protected]",
"waiter_priority_upon_offboarding": 24382,
"waiter_referral_bool": TRUE,
"waiter_created": "%Y-%m-%d %H:%M",
"waiter_removed": "%Y-%m-%d %H:%M",
"waiter_amount_referred": 0,
"waiter_referral_token": "13Aeh7A",
"waiter_referred_by_token": "hd8Adn9"