API reference

The npayload API lets you manage channels, publish messages, create subscriptions, and handle deliveries programmatically. All endpoints use REST conventions with JSON request and response bodies.

All API requests require authentication via OAuth 2.0 with DPoP proof-of-possession. See the authentication guide for details.

Core resources

Channels

Create, list, update, and delete messaging channels

Messages

Publish messages, batch publish, and replay from streams

Subscriptions

Manage webhook and queue subscriptions

Delivery and reliability

Deliveries

Track delivery status and retry failed deliveries

Dead letter queue

Inspect and reprocess failed messages

API keys

Create, rotate, and manage API keys

Base URL

https://api.npayload.com/v1

Authentication

curl -H "Authorization: DPoP <access_token>" \
  -H "DPoP: <dpop_proof>" \
  https://api.npayload.com/v1/channels

See the authentication guide for the full OAuth 2.0 + DPoP flow.

Was this page helpful?