> ## 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.

# Integrations

> Shopify Flow, outbound webhooks, the REST API, Sidekick, the AI connector, and what the web pixel does.

Ways to get Notifylyst events and data out of the app, in rising order of effort.

| Integration | Reach for it when |
| - | - |
| **Shopify Flow** | You want automation inside Shopify with no code at all. |
| **Webhooks** | You want events in n8n, Zapier or Make. |
| **REST API** | You are building something yourself. |
| **Sidekick** | You want to ask Shopify's assistant about waiting demand, inside your admin. |
| **AI connector (MCP)** | You want Claude or another AI tool to read — and, with your confirmation, change — your Notifylyst data. |

## Shopify Flow

Notifylyst adds three Flow triggers. In Flow, start a new workflow, choose **Select trigger**, then
pick **CB Notifylyst**.

![Shopify Flow's Select trigger panel for Notifylyst, listing its three triggers: Converted purchase, New subscriber and Notification sent.](https://mintcdn.com/codebeans-cb-notifylyst/gnV6Hi65a6BLRXRz/images/app-32-flow-triggers.png?fit=max\&auto=format\&n=gnV6Hi65a6BLRXRz\&q=85\&s=45f9d0f7e4f6cdd34d6b687d51555a07)

| Trigger | Fires when | Data you can use |
| - | - | - |
| **New subscriber** | A shopper signs up for an alert. | Product, Email, Channel, Phone, Product title, Variant title, SKU, Requested quantity, Form answers |
| **Notification sent** | A restock alert goes out on any channel. | Product, Channel, Recipient, Product title, Variant title, Campaign step, Requested quantity |
| **Converted purchase** | A shopper buys after an alert. | Product, Order, Channel, Conversion type (direct or assist), Product title, Variant title, Customer email, Customer phone, Revenue, Quantity |

Notifylyst has no Flow actions — only triggers.

Ideas: tag customers who keep waiting for a sold-out line; post to Slack when a high-value product
converts; add shoppers who converted to a segment.

## Webhooks

**Settings → Webhooks** sends events to n8n, Zapier, Make or your own endpoint the moment they
happen.

![Settings → Webhooks showing endpoints used against the plan's limit, the Add endpoint button, the three events, and the Recent deliveries log.](https://mintcdn.com/codebeans-cb-notifylyst/helB_Y1ZQRw5r3Uo/images/app-30-webhooks.png?fit=max\&auto=format\&n=helB_Y1ZQRw5r3Uo\&q=85\&s=b2e5c07f41f1ee143d50e0c7eb11104d)

| Event | Meaning |
| - | - |
| `subscriber.created` | **New subscriber** — someone requested a back-in-stock alert. |
| `notification.sent` | **Notification sent** — a restock alert was sent. |
| `notification.converted` | **Converted (purchase)** — a subscriber bought after being notified. |

1. Press **Add endpoint**, give it a **Name** and a **Destination URL**, and pick its events.
2. New endpoints start **off**: use **Send test** to check your receiver, then switch it on.
3. **Recent deliveries** shows each delivery with its HTTP status, attempt and time.

The URL must use HTTPS, point to a public address and contain no username or password; otherwise
you see **URL must use HTTPS.**, **URL must point to a public internet address.** or **URL must not
contain credentials.**

The number of endpoints depends on your plan (**Endpoints: X of Y used**). At the limit, **Add
endpoint** becomes an upgrade button: **Your plan includes N webhook endpoints. Upgrade to add more,
or remove one first.**

> [!NOTE]
>
> **Pick Flow or webhooks for a job, not both.** Two systems reacting to the same sign-up is the
> usual cause of a shopper getting two of everything.

## REST API

**Settings → API key** gives you a key to read your sign-up and notification data from your own
systems — a dashboard, a warehouse system, a data warehouse. **API documentation** opens the
reference.

![Settings → API key with the live key's status, Regenerate key and Revoke key, and the Try it example request; the key is blurred.](https://mintcdn.com/codebeans-cb-notifylyst/helB_Y1ZQRw5r3Uo/images/app-35-api-key.png?fit=max\&auto=format\&n=helB_Y1ZQRw5r3Uo\&q=85\&s=f3028e3c6a1707060126f06f57a8ebcc)

* The full key (starting `nl_live_`) is shown **once**, when it's created. Lost it? **Regenerate
  key**: the new key replaces the old one, which stops working straight away.
* **Revoke key** switches API access off until you create a new key.
* Send the key in the `X-API-Key` header, for example to `https://api.notifylyst.com/v1/data`.
* Requests are rate-limited by plan. Over the limit you get HTTP 429; the `X-RateLimit-Limit` header
  shows your limit.

Treat the key like a password: never put it in front-end code or a shared document.

## Sidekick

Notifylyst works with Shopify's Sidekick assistant in your admin. Sidekick can:

* answer questions about waiting demand — which products to restock first, who is waiting for a
  product, and your Notifylyst settings;
* prepare changes to your alert channels, report emails and restock rule. It opens **Settings**
  with the change filled in — **you** review it and press **Save**.

## AI connector (MCP)

Connect Claude or another AI tool and ask in plain language — *"which products are people waiting
for that I already have stock of?"* — with your confirmation needed before anything changes.

> [card] [AI connector guide](https://codebeans-cb-notifylyst.mintlify.site/mcp/overview.md)
>
> What it can reach, how to connect it, and how to limit what it may touch.

## The web pixel

Notifylyst installs a Shopify web pixel. It does one thing: when a shopper arrives from an alert
link and then completes checkout, it tells Notifylyst, so the order counts as **Direct**. It doesn't
track other browsing or widget use. Nothing to configure.

> [card] [Reference](https://codebeans-cb-notifylyst.mintlify.site/app/reference/overview.md)
>
> Next: lookup tables for every setting and report.


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