Notify docs
API reference

Notify API.

The management API your server, the console and the MCP server use, and the client API browsers and apps call with a recipient token. Every endpoint, request and response, generated from the live OpenAPI spec.

Base URL

https://api.notify.productcraft.co

Auth

Authorization: Bearer …

Spec version

OpenAPI 3.0.0 · v0.1.0

Approvals

Approval requests: an AI agent or your backend asks people a yes/no question before acting (agents propose, humans approve). The question reaches them on the type's channels; the first answer wins and comes back as the signed `approval.resolved` webhook and here. Requests time out, and every step is in their trail and the audit log.


Deliveries

One row per notification, recipient, channel and target (the inbox, an email address or a device), with its state, the reason for every skip, retry or failure, and each provider attempt.


Export

The whole Notify configuration of a workspace as JSON, to keep in source control or apply to another workspace.


Recipient-Tokens

Short-lived tokens your backend mints for one signed-in user, so their app or browser can call the client API without your secret key. Revoke one recipient's tokens, or every token of the workspace.


Recipients

The people you notify, keyed by your own user id (`external_id`), with their email, phone, locale, time zone, quiet hours, your custom properties, their devices (APNs and FCM tokens, web push subscriptions) and their preferences. Erase one for GDPR with `DELETE`.


Settings

Workspace settings: email on or off, and the automatic email pause (more than 0.1 % complaints or 5 % hard bounces among recent emails) with how to resume it.


Setup-Status

A checklist of what Notify needs before notifications reach anyone (a notification type, the Mail sender and templates for email), with where to fix each item.


Stats

Daily delivery counts per channel from an hourly rollup (planned, sent, delivered, failed, skipped, inbox reads), kept beyond the 30 days of delivery history.


Webhooks

Signed webhooks (Standard Webhooks) for sends, delivery outcomes (sent, delivered, failed, bounced, skipped with the reason), inbox reads, archives and clicks, pruned and moved devices, refused credentials, the email auto-pause and recipient erasure, with an event log, retries, Send test and replay. Payloads carry ids, the type key, channel, state and reason: never rendered text, addresses or tokens.