Webhooks

Add a Webhook to your Waitlist to be notified when a new waiter signs up or when you offboard a waiter from your dashboard .

Steps to activate

  1. Navigate to the "Features" tab on your Dashboard.
  2. Add your webhook URL in the "Webhook URL" section as seen below. Alt Image
  3. When a user signs up, we POST to your webhook url
POST/[YOUR CONFIGURED URL]

New Waiter Signup

  • Name
    event
    Type
    string
    Description

    When a new user signs up, the event will always be new_waiter

  • Name
    waiter_id
    Type
    string
    Description

    Every user is assigned a unique ID

  • Name
    waiter_email
    Type
    string
    Description

    The email of the user that signed up

  • Name
    waiter_priority
    Type
    integer
    Description

    Their current priority in the waitlist

  • Name
    waiter_referral_bool
    Type
    boolean
    Description

    Whether the user has been referred by another user

  • Name
    waiter_created
    Type
    string
    Description

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

  • Name
    waiter_amount_referred
    Type
    integer
    Description

    The amount of other users the user has referred

  • Name
    waiter_referral_token
    Type
    string
    Description

    Every user has a unique referral token used to identify referrals.

  • Name
    waiter_referred_by_token
    Type
    string
    Description

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

Webhook Response

{
  "event": "new_waiter",
  "waiter_id": 12,
  "waiter_email": "new_user@example.com",
  "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"
}
POST/[YOUR CONFIGURED URL]

Waiter Offboarded

This triggers when a user is offboarded from your waitlist dashboard

  • Name
    event
    Type
    string
    Description

    When a user is offboarded the event will always be offboarded_waiter

  • Name
    waiter_id
    Type
    string
    Description

    Every user is assigned a unique ID

  • Name
    waiter_email
    Type
    string
    Description

    The email of the user that was offboarded

  • Name
    waiter_priority_upon_offboarding
    Type
    integer
    Description

    The users priority in waitlist when they are offboarded

  • Name
    waiter_referral_bool
    Type
    boolean
    Description

    Whether the user was referred by another user when they first signed up

  • Name
    waiter_created
    Type
    string
    Description

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

  • Name
    waiter_removed
    Type
    string
    Description

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

  • Name
    waiter_amount_referred
    Type
    integer
    Description

    The amount of other users the user has referred during the time that they weren't offboarded

  • Name
    waiter_referral_token
    Type
    string
    Description

    Every user has a unique referral token used to identify referrals.

  • Name
    waiter_referred_by_token
    Type
    string
    Description

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

Webhook Response

{
  "event": "offboarded_waiter",
  "waiter_id": 12,
  "waiter_email": "new_user@example.com",
  "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"
}