> ## Documentation Index
> Fetch the complete documentation index at: https://codebeans-cb-notifylyst.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Webhooks

> Get told the moment a sign-up, a sent alert or a purchase happens, instead of polling the API.

Webhooks push events to a URL you choose — n8n, Zapier, Make or your own server — as they happen.
Set them up in the app under **Settings → Webhooks**; the full walkthrough is in
[Integrations](https://codebeans-cb-notifylyst.mintlify.site/app/guides/integrations.md#webhooks).

| Event | When it fires |
| - | - |
| `subscriber.created` | A shopper signed up on your storefront, or a sign-up was added in the app or through the [API](https://codebeans-cb-notifylyst.mintlify.site/api/subscribers.md). |
| `notification.sent` | A restock alert went out to a subscriber. |
| `notification.converted` | An order was attributed to a restock alert. |

## Use them with the API

* **Sync sign-ups into another tool:** listen for `subscriber.created`; call
  [`GET /api/v1/subscribers/{id}`](https://codebeans-cb-notifylyst.mintlify.site/api/subscribers#get-one-subscriber) when you need the full record.
* **Backfill first, then listen:** page through [`GET /api/v1/subscribers`](https://codebeans-cb-notifylyst.mintlify.site/api/subscribers#list-subscribers)
  once, then let webhooks keep you current.
* **Mirror opt-outs** back from your email tool with
  [`POST /api/v1/unsubscribes`](https://codebeans-cb-notifylyst.mintlify.site/api/reports#opt-someone-out).

Sign-ups added through the API carry `"source": "api"` (single) or `"source": "api_bulk"` in the
`subscriber.created` payload, so your receiver can tell them from storefront sign-ups.

The number of webhook endpoints depends on your plan.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.