Zapier: Documentation for Integrating your Waitlist

You can integrate external services via Zapier. We make it easy to link with your Zapier account, and you can then trigger external services on Waitlist or Signup Actions.

Steps to activate

Navigate to the "Features" tab on your Dashboard.
Check the "Zapier Access" box, and Save.
Navigate to the "General" tab on your Dashboard, and copy your Zapier Key:
Navigate to Zapier and search for the Waitlist app. Alternatively, click here to Access the Zapier App.
When asked for a key, paste in the Zapier key you copied from the Waitlist Dashboard in step 3. (Do not paste in your Waitlist API Key).
You should be ready to go!

Available Zaps

New Signup

Example Use Case: Send a custom email when a user signs up! Connect with a service like Mailchimp or Convertkit, and place the new Signup into an email funnel.

This Zap triggers when a new user signs up to your waitlist. The included variables are outlined below.

Name
id
Type
string
Description
This is the unique ID of your signed up user. This is helpful if you want to consolidate your record system with getwaitlist.com.
Name
amount_referred
Type
integer
Description
This is the total number of users that have been referred by this signup. At first, it will always be 0.
Name
email
Type
string
Description
The email of the signed up user.
Name
first_name
Type
string
Description
The first name of the signed up user.
Name
last_name
Type
string
Description
The last name of the signed up user.
Name
phone
Type
string
Description
This will be returned if you collect phone numbers on signup via the no-code widget or API. We verify the format of the number, but not the identity.
Name
referral_bool
Type
boolean
Description
This parameter will be True is this user has been referred by another user.
Name
referral_token
Type
string
Description
This is the referral token for this user, which we use to construct referral links. For example, if your waitlist is located on x.com, a user might get x.com/?ref_id=VU8CLWFOL as their referral link.
Name
referred_by_waiter_token
Type
string
Description
If this user is referred, it will include the referral_token of the user who referred them.
Name
removed_date
Type
string
Description
If the user is offboarded, this will include the date they were offboarded. For new signups, this will be null.
Name
removed_priority
Type
string
Description
This is what the priority of the signup was when they were offboarded from the waitlist. For new signups, this will be null.
Name
total_referrals
Type
integer
Description
This is deprecated. Please use amount_referred.
Name
uuid
Type
string
Description
This is deprecated. Please use the id parameter.
Name
user_id
Type
string
Description
This is deprecated. Please use id.
Name
verified
Type
boolean
Description
If you have turned on double-opt in verification via your getwaitlist.com dashboard, this will be true. We're working on a Zapier update to have a Zap for this.
Name
waitlist_api_key
Type
string
Description
The public API key for this waitlist.
Name
waitlist_id
Type
string
Description
The public ID for this waitlist.

New Signup Zap

{
  {
    "id": 1,
    "amount_referred": 0,
    "created_at": "2022-06-24_18-27-53",
    "email": "foo@example.com",
    "first_name": "test",
    "last_name": "test_last",
    "phone": "",
    "referral_bool": false,
    "referral_token": "VU8CLWFOL",
    "referred_by_waiter_token": null,
    "registered_email": "foo@example.com",
    "removed_date": null,
    "removed_priority": 1,
    "total_referrals": 0,
    "user_id": "072fbb3610c043173eb94172db013076",
    "uuid": "749a6205-0585-476d-98c4-ba9ed3746260",
    "verified": false,
    "waitlist_api_key": "waitlist_api_key",
    "waitlist_id": 1550
  }
}

New Referrer

Example Use Case: Send a thank you note to the person who referred someone else.

Triggers when an existing user refers another user. The included variables are outlined below.

Name
id
Type
string
Description
This is the unique ID of your signed up user. This is helpful if you want to consolidate your record system with getwaitlist.com.
Name
amount_referred
Type
integer
Description
This is the total number of users that have been referred by this signup. At first, it will always be 0.
Name
email
Type
string
Description
The email of the signed up user.
Name
first_name
Type
string
Description
The first name of the signed up user.
Name
last_name
Type
string
Description
The last name of the signed up user.
Name
phone
Type
string
Description
This will be returned if you collect phone numbers on signup via the no-code widget or API. We verify the format of the number, but not the identity.
Name
referral_bool
Type
boolean
Description
This parameter will be True is this user has been referred by another user. In this Zap type, it will always be true.
Name
referral_token
Type
string
Description
This is the referral token for this user, which we use to construct referral links. For example, if your waitlist is located on x.com, a user might get x.com/?ref_id=VU8CLWFOL as their referral link.
Name
referred_by_waiter_token
Type
string
Description
If this user is referred, it will include the referral_token of the user who referred them. In this type of Zap, it will be populated with a token, for example "AUDIWUHNN".
Name
removed_date
Type
string
Description
If the user is offboarded, this will include the date they were offboarded. For new signups, this will be None.
Name
removed_priority
Type
string
Description
This is what the priority of the signup was when they were offboarded from the waitlist. For new signups, this will be None.
Name
total_referrals
Type
integer
Description
This is deprecated. Please use amount_referred.
Name
uuid
Type
string
Description
This is deprecated. Please use the id parameter.
Name
user_id
Type
string
Description
This is deprecated. Please use id.
Name
verified
Type
boolean
Description
If you have turned on double-opt in verification via your getwaitlist.com dashboard, this will be true. We're working on a Zapier update to have a Zap for this.
Name
waitlist_api_key
Type
string
Description
The public API key for this waitlist.
Name
waitlist_id
Type
string
Description
The public ID for this waitlist.

New Referral Zap

{
  {
    "id": 1,
    "amount_referred": 0,
    "created_at": "2022-06-24_18-27-53",
    "email": "foo@example.com",
    "first_name": "test",
    "last_name": "test_last",
    "phone": "",
    "referral_bool": true,
    "referral_token": "VU8CLWFOL",
    "referred_by_waiter_token": "AUDIWUHNN",
    "registered_email": "foo@example.com",
    "removed_date": None,
    "removed_priority": 0,
    "total_referrals": 0,
    "user_id": "072fbb3610c043173eb94172db013076",
    "uuid": "749a6205-0585-476d-98c4-ba9ed3746260",
    "verified": false,
    "waitlist_api_key": "waitlist_api_key",
    "waitlist_id": 1550
  }
}

Offboard Signup

Example use case: When a user is off the Waitlist and is ready to use your product, let them know! Connect with a service like Klaviyo or Mailchimp, and send them an automated email.

This Zap triggers when you offboard a Signup from the Waitlist using your Dashboard. The included variables are outlined below.

Name
id
Type
string
Description
This is the unique ID of your signed up user. This is helpful if you want to consolidate your record system with getwaitlist.com.
Name
amount_referred
Type
integer
Description
This is the total number of users that have been referred by this signup. At first, it will always be 0.
Name
email
Type
string
Description
The email of the signed up user.
Name
first_name
Type
string
Description
The first name of the signed up user.
Name
last_name
Type
string
Description
The last name of the signed up user.
Name
phone
Type
string
Description
This will be returned if you collect phone numbers on signup via the no-code widget or API. We verify the format of the number, but not the identity.
Name
referral_bool
Type
boolean
Description
This parameter will be True is this user has been referred by another user. In this Zap type, it will always be true.
Name
referral_token
Type
string
Description
This is the referral token for this user, which we use to construct referral links. For example, if your waitlist is located on x.com, a user might get x.com/?ref_id=VU8CLWFOL as their referral link.
Name
referred_by_waiter_token
Type
string
Description
If this user is referred, it will include the referral_token of the user who referred them. In this type of Zap, it will be populated with a token, for example "AUDIWUHNN".
Name
removed_date
Type
string
Description
If the user is offboarded, this will include the date they were offboarded. For this Zap, this will be populated, as shown in the JSON example.
Name
removed_priority
Type
string
Description
This is what the priority of the signup was when they were offboarded from the waitlist. For this Zap, it will always be populated. In our JSON example, it's slowing as 1.
Name
total_referrals
Type
integer
Description
This is deprecated. Please use amount_referred.
Name
uuid
Type
string
Description
This is deprecated. Please use the id parameter.
Name
user_id
Type
string
Description
This is deprecated. Please use id.
Name
verified
Type
boolean
Description
If you have turned on double-opt in verification via your getwaitlist.com dashboard, this will be true. We're working on a Zapier update to have a Zap for this.
Name
waitlist_api_key
Type
string
Description
The public API key for this waitlist.
Name
waitlist_id
Type
string
Description
The public ID for this waitlist.

Offboarded Signup Zap

{
  {
    "id": 1,
    "amount_referred": 20,
    "created_at": "2022-06-24_18-27-53",
    "email": "foo@example.com",
    "first_name": "test",
    "last_name": "test_last",
    "phone": "",
    "referral_bool": false,
    "referral_token": "VU8CLWFOL",
    "referred_by_waiter_token": null,
    "registered_email": "foo@example.com",
    "removed_date": "2023-01-01_18-27-53",
    "removed_priority": 1,
    "total_referrals": 0,
    "user_id": "072fbb3610c043173eb94172db013076",
    "uuid": "749a6205-0585-476d-98c4-ba9ed3746260",
    "verified": false,
    "waitlist_api_key": "waitlist_api_key",
    "waitlist_id": 1550
  }
}

Data Schema

For all available Zaps, the content is always an Authenticated Signup Object.