Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

NotificationAPI Send API

Send and retract notifications across channels.

NotificationAPI Send API is one of 7 APIs that NotificationAPI publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Send. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 2 operations across 2 paths, and defines 7 schemas. It is described by OpenAPI 3.0.3, at version 2.8.

Requests are made against 3 base URLs: https://api.notificationapi.com/{clientId}, https://api.eu.notificationapi.com/{clientId}, https://api.ca.notificationapi.com/{clientId}.

2 operations 2 paths 7 schemas 2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
2.8
Base URL
https://api.notificationapi.com/{clientId}
Authentication
HTTP Basic
Terms of Service
Resource Areas
1

Authentication & Security 1

NotificationAPI Send API declares 1 security scheme for authenticating requests. It accepts HTTP basic authentication (basicAuth). By default, every request must be authenticated.

  • basicAuth — HTTP Basic authentication. For account-level calls the username is your clientId and the password is your clientSecret. Per-user calls (identify user, in-app i…

Paths & Operations 2

Across 2 paths, the API surfaces 2 operations — 2 POST. Each is listed below with its method, path, parameters, and response codes.

Send 2

Send and retract notifications across channels.

POST
/sender
Send a notification
send body → 200202401
POST
/sender/retract
Retract a notification
retract body → 200401

Schemas 7

The contract defines 7 schemas that model the data the API accepts and returns. The most detailed are SendRequest (14 properties), User (9 properties), PushToken (3 properties), RetractRequest (3 properties). Each schema is shown below with its type and property counts.

SendRequest
object
A request to send (or schedule) a notification. type names the notification configured in your dashboard; to is the recipient; parameters are merged into the t…
14 properties
RetractRequest
object
3 properties 2 required
PushToken
object
3 properties 3 required
Channel
string
User
object
A user you notify.
9 properties 1 required
Error
object
2 properties
SendResponse
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

notificationapi-send-api-openapi.yml Raw ↑

Other APIs NotificationAPI publishes across the network.

NotificationAPI In-App Inbox API
NotificationAPI Logs API
NotificationAPI Notifications API
NotificationAPI Schedule API
NotificationAPI User Preferences API
NotificationAPI Users API