Schemas
Waitlist
idstring · uuid · readOnly · requiredThe id of the waitlist.
namestring · requiredThe name of the waitlist.
websitestring · uri · requiredThe website of the associated waitlist.
NewWebhook
namestring · requiredThe name of the webhook.
urlstring · · requiredThe endpoint that you want us to send events to.
eventsstring[] · minItems: 1 · unique · requiredThe list of events you want us to send to your endpoint.
Enum values:NewSignupNewReferral
activebooleanThis value controls whether the webhook will have events sent to it, or not.
filterobjectFilter events by certain criteria.
Webhook
webhook_idstring · uuid · readOnly · requiredThe id of the webhook.
namestring · requiredThe name of the webhook.
urlstring · · requiredThe endpoint that you want us to send events to.
activeboolean · requiredThis value controls whether the webhook will have events sent to it, or not.
eventsstring[] · minItems: 1 · unique · requiredThe list of events you want us to send to your endpoint.
Enum values:NewSignupNewReferral
filterobjectFilter events by certain criteria.
Event
Role
SignUp
emailstring · email · requiredThe email address that signed up.
verifiedboolean · requiredIf the email has been verified by the user.
referralboolean · requiredIf this signup was a referral from someone.
custom_inputsobject[] · requiredAn array of custom input objects provided during signup.
