API explorer
Explore the scoped Notify Agent API, inspect request and response schemas, and try an authenticated request.
Requests use an explicit scoped bearer token. The playground sends a real request only when you choose Send.
Read about access and consent · Download OpenAPI 3.1
Describe the calling token
GET /api/agent/auth/status
Revoke the calling token
POST /api/agent/auth/revoke
List the account's API tokens (never secrets)
GET /api/agent/tokens
Revoke another token of the same account
DELETE /api/agent/tokens/{id}
List registered devices
GET /api/agent/devices
Remove a device; it registers again when Notify next opens on it
DELETE /api/agent/devices/{id}
List webhook services (without webhook URLs)
GET /api/agent/services
Create a webhook service; the webhook URL is returned once
POST /api/agent/services
Get a webhook service
GET /api/agent/services/{id}
Update a webhook service's title, avatar, or tap URL
PATCH /api/agent/services/{id}
Delete a webhook service
DELETE /api/agent/services/{id}
Share a webhook service with your family, or unshare it
POST /api/agent/services/{id}/share
Rotate the webhook token; the new URL is returned once
POST /api/agent/services/{id}/rotate
List the account's saved Reply webhooks
GET /api/agent/webhooks
Create a Reply webhook; its signing secret is returned once
POST /api/agent/webhooks
Get a Reply webhook and its recent deliveries
GET /api/agent/webhooks/{id}
Update a Reply webhook's endpoint, preset, headers, events, or enabled state
PATCH /api/agent/webhooks/{id}
Delete a Reply webhook
DELETE /api/agent/webhooks/{id}
Send a signed sample event to a Reply webhook
POST /api/agent/webhooks/{id}/test
Rotate a Reply webhook signing secret; the replacement is returned once
POST /api/agent/webhooks/{id}/rotate-secret
Recent webhook deliveries
GET /api/agent/events
Merged account activity history, newest first (20 per page)
GET /api/agent/activity-feed
Send a one-shot push
POST /api/agent/notifications
Withdraw an agent notification from the account's devices
POST /api/agent/notifications/{id}/withdraw
List the account's pending prompts from every source
GET /api/agent/interactions
Ask a question (approval, yes/no, or reply)
POST /api/agent/interactions
Get a prompt created by this token
GET /api/agent/interactions/{id}
Long-poll a prompt created by this token until it is answered
GET /api/agent/interactions/{id}/wait
Cancel a pending prompt created by this token
POST /api/agent/interactions/{id}/cancel
List Live Activities started by this token
GET /api/agent/activities
Start a Live Activity
POST /api/agent/activities
Get a Live Activity by ID or key
GET /api/agent/activities/{identifier}
Update a Live Activity
PATCH /api/agent/activities/{identifier}
End a Live Activity
POST /api/agent/activities/{identifier}/end
List web apps
GET /api/agent/apps
Register a web app (an existing URL is updated)
POST /api/agent/apps
Get a web app
GET /api/agent/apps/{id}
Update a web app's name, URL, icon, or project
PATCH /api/agent/apps/{id}
Remove a web app
DELETE /api/agent/apps/{id}
Revoke this account's sign-in consent; approve again on next open
POST /api/agent/apps/{id}/revoke
Move an app into a team or family, or (teamId null) back to your own apps
POST /api/agent/apps/{id}/share
List the teams you belong to
GET /api/agent/teams
Create a family; you become its owner
POST /api/agent/teams
A team and its members
GET /api/agent/teams/{id}
Update a team (name: admin; auto-join and retention: owner)
PATCH /api/agent/teams/{id}
Delete a team (owner); its apps return to the members who added them
DELETE /api/agent/teams/{id}
Leave a team (the owner must transfer ownership first)
POST /api/agent/teams/{id}/leave
Change a member's role; `owner` transfers ownership (owner only)
PATCH /api/agent/teams/{id}/members/{userId}
Remove a member (admin or owner); the owner cannot be removed
DELETE /api/agent/teams/{id}/members/{userId}
List invites (admin or owner)
GET /api/agent/teams/{id}/invites
Create a 7-day join link (admin or owner)
POST /api/agent/teams/{id}/invites
Revoke an invite
DELETE /api/agent/teams/{id}/invites/{inviteId}
The team's shared apps
GET /api/agent/teams/{id}/apps
The team's device groups
GET /api/agent/teams/{id}/groups
Create a device group (admin or owner)
POST /api/agent/teams/{id}/groups
A device group
GET /api/agent/teams/{id}/groups/{groupId}
Update a device group (admin or owner)
PATCH /api/agent/teams/{id}/groups/{groupId}
Delete a device group (admin or owner)
DELETE /api/agent/teams/{id}/groups/{groupId}
Devices belonging to team members (admin or owner)
GET /api/agent/teams/{id}/devices
Request a DNS TXT challenge for an email domain (owner)
POST /api/agent/teams/{id}/domain
Clear the pending or verified domain (owner)
DELETE /api/agent/teams/{id}/domain
Verify the pending domain's DNS TXT record (owner)
POST /api/agent/teams/{id}/domain/verify
Audit log (admin or owner); members receive 403
GET /api/agent/teams/{id}/audit
The team's on-call groups with current and upcoming shifts
GET /api/agent/teams/{id}/oncall
Create an on-call group (admin or owner)
POST /api/agent/teams/{id}/oncall
The team's pages, newest first
GET /api/agent/teams/{id}/pages
Your upcoming shifts and the open pages that notified you
GET /api/agent/oncall/me
An on-call group
GET /api/agent/oncall/{groupId}
Edit a group's name, rotation, or escalation (admin or owner)
PATCH /api/agent/oncall/{groupId}
Delete an on-call group (admin or owner)
DELETE /api/agent/oncall/{groupId}
Put someone on call for a window (admins: anyone; members: themselves)
POST /api/agent/oncall/{groupId}/overrides
Remove an override
DELETE /api/agent/oncall/{groupId}/overrides/{overrideId}
Page the group: whoever is on call first, then escalation
POST /api/agent/oncall/{groupId}/pages
A page
GET /api/agent/pages/{id}
List tunnel connectors
GET /api/agent/connectors
Register a tunnel connector; the callback HMAC secret is returned once
POST /api/agent/connectors
A tunnel connector
GET /api/agent/connectors/{id}
Update a connector's name, routes, or on-call group
PATCH /api/agent/connectors/{id}
Remove a tunnel connector
DELETE /api/agent/connectors/{id}
Mark a connector online and refresh its last-seen time
POST /api/agent/connectors/{id}/heartbeat
Connector gateway: consume a one-time Notify pass or revalidate its bound session on every request
POST /api/agent/connectors/{id}/access
Connector gateway: authorize one signed, recorded callback delivery and return its saved destination path
POST /api/agent/connectors/{id}/callback-access
Rotate a connector callback HMAC secret; the new secret is returned once
POST /api/agent/connectors/{id}/rotate-secret
Resolve a page; anyone still being paged is cleared
POST /api/agent/pages/{id}/resolve
Inbox projects with unread counts
GET /api/agent/inbox/projects
Inbox notifications, newest first, with cursor pagination
GET /api/agent/inbox/notifications
One inbox notification with its full body
GET /api/agent/inbox/notifications/{id}
Mark everything up to a list response's readThroughToken read
POST /api/agent/inbox/notifications/read-all
Mark one notification read
POST /api/agent/inbox/notifications/{id}/read
Mark one notification unread
POST /api/agent/inbox/notifications/{id}/unread
Plan, limits, and remaining usage
GET /api/agent/billing