Webhooks

Listen for events like new signups or referrals in real-time and trigger your own backend logic.

What are Webhooks?

Webhooks act as a "push" notification system. Instead of polling our API every minute to see if you have new signups, you provide us with a URL (e.g., https://api.yoursite.com/webhooks/waitlist), and we send a HTTP POST request to that URL whenever an event occurs.

Project vs Workspace Webhooks

We offer two scopes for webhooks to fit different use cases.

Project Webhooks

Scoped to a single project. Configured in the project settings.

  • Best for: Single-app integrations.
  • Payload: Contains project-specific data.
  • Events: Primarily signup.confirmed.

Workspace Webhooks

Scoped to your entire account. Configured in global settings.

  • Best for: Agencies, CRMs, Analytics.
  • Payload: Includes project_id context.
  • Events: All events (created, confirmed, referred).

Event Lifecycle

The typical flow for a signup is:

  1. User submits form → signup.created fires (status: pending).
  2. User clicks email link → signup.confirmed fires (status: confirmed).
  3. If the user was referred by someone, signup.referred also fires to notify you about the referrer.