Full Programmatic Control With the NotiProof REST API

For teams that need more than a webhook — reading campaign data, managing notification settings, or pushing events from a backend service — NotiProof's REST API provides authenticated endpoints to create events and manage your account programmatically.

Connect REST API Free

Why Use NotiProof With REST API

Push events directly from your backend
Read campaign and analytics data programmatically
Manage notification settings without the dashboard UI
Build fully custom internal tooling on top of NotiProof
API-key based authentication scoped per account

Setup in 3 Simple Steps

1

Generate an API Key

In your NotiProof dashboard, go to API settings and generate a secret API key scoped to your account.

2

Make Authenticated Requests

Send requests with an Authorization header of 'Bearer YOUR_API_KEY'. To create an event, POST to the events endpoint with a body like: name: James, location: Denver CO, event_type: purchase, product_name: Pro Plan.

3

Handle Responses and Errors

A successful call returns a 201 with the created event's ID; handle 401 (invalid key), 429 (rate limited), and 4xx validation errors in your integration code, and implement your own retry logic for 5xx responses.

Features

Authenticated endpoints for events, campaigns, and analytics
Bearer token API key authentication
Standard HTTP status codes for success and error handling
Per-account rate limiting to protect platform stability
Idempotency key support on event creation endpoints
JSON request and response bodies throughout

See REST API in Action

Learn how businesses use NotiProof with REST API to increase conversions.

SaaSWebhooksZapier

Frequently Asked Questions

How is the REST API different from webhooks?
Webhooks are typically one-directional and event-focused; the REST API is broader, letting you also read data and manage account/campaign settings, not just push events.
What's a sample event creation payload?
A typical body: name: James, location: Denver CO, event_type: purchase, product_name: Pro Plan, timestamp: an ISO 8601 date. The API returns the created event's ID and status.
Are there rate limits?
Yes, requests are rate-limited per API key based on your plan; exceeding the limit returns a 429 status with a Retry-After header.
How do I prevent duplicate events on retry?
Pass an idempotency_key in the request body; resending the same key within the idempotency window returns the original result instead of creating a duplicate.
Does the API support reading analytics data?
Yes, read endpoints exist for campaign performance and notification counts, useful for building custom dashboards or reports.
Is there client library support?
The API is standard REST/JSON, so it works with any HTTP client in any language; check current documentation for any officially maintained SDKs.

Related Reading

The REST API is well suited for server-side implementations — read more: Server-Side Tracking.

Use the API's analytics endpoints as part of your measurement setup: Social Proof Analytics Setup.

Plan which events to push via the API: Event Tracking for Social Proof.

Explore More Integrations

All IntegrationsShopifyWordPressZapier

Ready to Increase Your Conversions?

Start using NotiProof free today and turn visitors into customers with social proof. No credit card required.

Get Started Free View Pricing

Free forever plan · No credit card required