Skip to content

Authentication

The Renotify API is at https://renotify.app/api/v1. Every request needs an API key, sent as a Bearer token. The API is included in every plan.

  1. Go to Settings → Developers → API keys.
  2. Name the key after what uses it, such as “Billing system”.
  3. Choose its permissions:
Permission Allows
read Reading contacts, events, messages, templates and other resources
create Sending events, and creating contacts, segments and tags
update Changing existing resources
delete Deleting resources
  1. Copy the key when it’s shown. It’s only shown once.

A key acts for the workspace it was created in. Give each system its own key with only the permissions it needs; a system that only sends events needs just create.

Send the key in the Authorization header:

Terminal window
curl https://renotify.app/api/v1/events \
-H "Authorization: Bearer $RENOTIFY_API_KEY" \
-H "Accept: application/json"

Keep keys on your server; never put them in a browser or app. Delete a key under Settings → Developers → API keys to revoke it immediately.

Responses use JSON:API: each resource has a type, an id and its attributes.

{
"data": {
"id": "8812",
"type": "events",
"attributes": {
"name": "payment.due",
"contact_id": 311,
"data": { "amount": "$120.00" },
"source": "api",
"occurred_at": "2026-10-01T09:00:00.000000Z"
}
}
}

Lists are paginated: pass page and per_page (up to 100).

See Errors and limits for error responses, and the API reference for every endpoint.