Gen-Endpoint
Back to API List
Notification System API
Send emails, SMS, and push notifications with template support and delivery tracking.
Communication
Internal API - Hosted by this App
API Endpoints & Usage
Explore and interact with the available endpoints for the Notification System API. These API routes are live! The paths shown below are relative to your application's base URL. For example, if this application is hosted at https://gen-endpoint.com, an endpoint path for this API, such as /api/notifications/email, would be accessible at https://gen-endpoint.com/api/notifications/email. You can use the "Try it out" section for each endpoint or use tools like curl, Postman, or your browser's address bar (for GET requests) to interact with them.
POST

/api/notifications/email

Send email notification with template support.

Show Static Examples

Example Request Body:

{
  "to": "user@example.com",
  "template": "welcome",
  "variables": {"name": "John", "appName": "Gen-Endpoint", "verificationUrl": "https://app.com/verify/123"},
  "subject": "Welcome to our platform!"
}

Example Response:

{
  "id": "notif_123",
  "type": "email",
  "status": "queued",
  "scheduledAt": "2024-08-16T12:00:00Z",
  "estimatedDelivery": "2024-08-16T12:01:00Z"
}
Try it out
GET

/api/notifications/email

Get email notification history.

Show Static Examples

Example Request Parameters:

?status=delivered&limit=10

Example Response:

{
  "notifications": [
    {
      "id": "notif_123",
      "status": "delivered",
      "recipient": "user@example.com",
      "subject": "Welcome!",
      "deliveredAt": "2024-08-16T12:01:15Z"
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 10,
    "total": 5
  }
}
Try it out

You can add or change query parameters in the path above (e.g., ?name=User).

POST

/api/notifications/push

Send push notification to devices.

Show Static Examples

Example Request Body:

{
  "deviceTokens": ["token1", "token2"],
  "title": "New Message",
  "body": "You have a new message from Alice",
  "data": {"messageId": "msg_456", "type": "chat"}
}

Example Response:

{
  "id": "notif_124",
  "type": "push",
  "status": "sent",
  "deliveredTo": 2,
  "failedDeliveries": 0
}
Try it out
GET

/api/notifications/push

Get push notification history and stats.

Show Static Examples

Example Request Parameters:

?limit=10

Example Response:

{
  "notifications": [
    {
      "id": "notif_124",
      "title": "New Message",
      "status": "sent",
      "deliveredTo": 2,
      "createdAt": "2024-08-16T12:05:00Z"
    }
  ],
  "stats": {
    "totalSent": 10,
    "totalDelivered": 8,
    "successRate": 80
  }
}
Try it out

You can add or change query parameters in the path above (e.g., ?name=User).

GET

/api/notifications/templates

List available notification templates.

Show Static Examples

Example Response:

[
  {
    "id": "welcome",
    "name": "Welcome Email",
    "type": "email",
    "variables": [
      "name",
      "verificationUrl"
    ]
  },
  {
    "id": "password_reset",
    "name": "Password Reset",
    "type": "email",
    "variables": [
      "name",
      "resetUrl"
    ]
  }
]
Try it out

You can add or change query parameters in the path above (e.g., ?name=User).