API Reference
Notifery provides a simple and powerful REST API that allows you to integrate notification functionality into your applications, services, scripts, and monitoring systems.
Base URL
All API requests should be sent to:
https://api.notifery.comAuthentication
Most Notifery API endpoints require authentication using an API key. You can obtain an API key from your Notifery dashboard.
API keys can be provided in one of two ways:
- Via the
x-api-keyHTTP header (recommended) - Via the
apiKeyparameter in the request body or query string (depending on the endpoint)
Rate Limiting
To ensure service stability, the Notifery API implements rate limiting. Current limits are:
- 20 requests per 20-second window
When rate limits are exceeded, the API will return a 429 Too Many Requests response.
Available Endpoints
| Endpoint | Description |
|---|---|
| /event | Send events/notifications to a zone |
Response Format
All API responses are returned in JSON format. Successful requests typically return a 2xx status code, while errors return appropriate 4xx or 5xx status codes with an error message in the response body.
Errors
Common error status codes:
| Status Code | Description |
|---|---|
| 400 | Bad Request - The request is malformed or missing required parameters |
| 401 | Unauthorized - Authentication failed or required API key is missing |
| 422 | Unprocessable Entity - Request validation failed or plan limits exceeded |
| 429 | Too Many Requests - Rate limit exceeded |
| 500 | Internal Server Error - Something went wrong on the server |
Need Help?
If you have any questions or need assistance with the API, please refer to the Getting Started guide or contact our support team.