Skip to main content
The API Alerts REST API enables direct integration with our notification service. While we recommend using our SDKs for most use cases, the API is available for custom implementations.

OpenAPI / Swagger

Explore and test the API interactively using the live Swagger UI.

​
Base URL

https://api.apialerts.com

​
Authentication

All requests require a workspace API key passed as a Bearer token in the Authorization header. 
Authorization: Bearer YOUR-API-KEY
API keys are scoped to a workspace and can be created in the dashboard.

​
Request Headers

Authorization: Bearer YOUR-API-KEY
Content-Type: application/json

​
Endpoints

MethodPathDescription
POST/eventSubmit an event notification

​
Error Responses

All error responses follow this format: 
{
  "message": "Error description"
}
StatusDescription
400Invalid request body or validation error
401Invalid or missing API key
429Monthly quota exceeded (resets on the 1st of the month or your plan renewal date)