aid: notificationapi url: https://raw.githubusercontent.com/api-evangelist/notificationapi/refs/heads/main/apis.yml name: NotificationAPI kind: company description: NotificationAPI is notifications infrastructure for developers. A single REST API and drop-in in-app inbox component send multi-channel notifications - email, SMS, mobile and web push, in-app inbox, automated voice call, and Slack - while managing user identities, per-user preferences and opt-outs, templates, scheduling, and delivery logs. All calls are scoped to a clientId and authenticated with HTTP Basic auth. image: https://kinlane-images.s3.amazonaws.com/shared/apis-json/apis-json-logo.jpg tags: - Notifications - Messaging - Email - SMS - Push - In-App Inbox created: '2026-07-01' modified: '2026-07-01' specificationVersion: '0.19' apis: - aid: notificationapi:notificationapi-send-api name: NotificationAPI Send API tags: - Send - Notifications - Multi-Channel image: https://kinlane-images.s3.amazonaws.com/shared/apis-json/apis-json-logo.jpg humanURL: https://docs.notificationapi.com/reference/send baseURL: https://api.notificationapi.com/{clientId} properties: - url: https://docs.notificationapi.com/reference/send type: Documentation - url: https://docs.notificationapi.com/reference/api-reference type: APIReference - url: openapi/notificationapi-openapi.yml type: OpenAPI description: Sends a notification to a user across the channels configured for the notification type - email, SMS, push, web push, in-app inbox, voice call, and Slack - with template parameters, per-channel overrides, and retract support via POST /sender and POST /sender/retract. - aid: notificationapi:notificationapi-schedule-api name: NotificationAPI Schedule API tags: - Schedule - Notifications - Delayed Delivery image: https://kinlane-images.s3.amazonaws.com/shared/apis-json/apis-json-logo.jpg humanURL: https://docs.notificationapi.com/reference/schedule baseURL: https://api.notificationapi.com/{clientId} properties: - url: https://docs.notificationapi.com/reference/schedule type: Documentation - url: openapi/notificationapi-openapi.yml type: OpenAPI description: Schedules notifications for future delivery by passing an ISO 8601 schedule value to the Send API, then updates or cancels them by trackingId via PATCH and DELETE /schedule/{trackingId}. - aid: notificationapi:notificationapi-users-identify-api name: NotificationAPI Users Identify API tags: - Users - Identify - Contacts image: https://kinlane-images.s3.amazonaws.com/shared/apis-json/apis-json-logo.jpg humanURL: https://docs.notificationapi.com/reference/identify-user baseURL: https://api.notificationapi.com/{clientId} properties: - url: https://docs.notificationapi.com/reference/identify-user type: Documentation - url: openapi/notificationapi-openapi.yml type: OpenAPI description: Creates or updates the users you notify with their contact identifiers - email, phone number, push and web-push tokens, timezone, and Slack channel - via POST /users/{userId}, authenticated with a per-user HMAC signature. - aid: notificationapi:notificationapi-user-preferences-api name: NotificationAPI User Preferences API tags: - Preferences - Opt-Out - Subscriptions image: https://kinlane-images.s3.amazonaws.com/shared/apis-json/apis-json-logo.jpg humanURL: https://docs.notificationapi.com/reference/set-user-preferences baseURL: https://api.notificationapi.com/{clientId} properties: - url: https://docs.notificationapi.com/reference/set-user-preferences type: Documentation - url: openapi/notificationapi-openapi.yml type: OpenAPI description: Sets and deletes per-user, per-notification, per-channel delivery preferences and opt-outs - off/instant/hourly/daily/weekly/monthly - via POST /user_preferences/{userId} and DELETE /users/{userId}/preferences. - aid: notificationapi:notificationapi-notifications-config-api name: NotificationAPI Notifications Config API tags: - Notifications - Configuration - SubNotifications image: https://kinlane-images.s3.amazonaws.com/shared/apis-json/apis-json-logo.jpg humanURL: https://docs.notificationapi.com/reference/create-sub-notification baseURL: https://api.notificationapi.com/{clientId} properties: - url: https://docs.notificationapi.com/reference/create-sub-notification type: Documentation - url: openapi/notificationapi-openapi.yml type: OpenAPI description: Configures notifications and their subNotifications - independently subscribable subcategories such as per-project or per-topic channels - via PUT and DELETE /notifications/{notificationId}/subNotifications/{subNotificationId}. - aid: notificationapi:notificationapi-in-app-inbox-api name: NotificationAPI In-App Inbox API tags: - In-App Inbox - Notifications - Read State image: https://kinlane-images.s3.amazonaws.com/shared/apis-json/apis-json-logo.jpg humanURL: https://docs.notificationapi.com/reference/in-app-notifications baseURL: https://api.notificationapi.com/{clientId} properties: - url: https://docs.notificationapi.com/reference/in-app-notifications type: Documentation - url: openapi/notificationapi-openapi.yml type: OpenAPI description: Powers the drop-in in-app inbox component - reads a user's INAPP_WEB notifications with pagination and marks them opened, clicked, archived, actioned, or replied via GET and PATCH /users/{userId}/notifications/INAPP_WEB. - aid: notificationapi:notificationapi-logs-api name: NotificationAPI Logs API tags: - Logs - Analytics - Delivery image: https://kinlane-images.s3.amazonaws.com/shared/apis-json/apis-json-logo.jpg humanURL: https://docs.notificationapi.com/reference/query-logs baseURL: https://api.notificationapi.com/{clientId} properties: - url: https://docs.notificationapi.com/reference/query-logs type: Documentation - url: openapi/notificationapi-openapi.yml type: OpenAPI description: Queries delivery and event logs filtered by date range, notification, channel, user, status, and trackingId via POST /logs/query. common: - type: DomainSecurity url: security/notificationapi-domain-security.yml - type: Authentication url: authentication/notificationapi-authentication.yml - url: https://www.pingram.io/blog type: Blog - type: GitHubOrganization url: https://github.com/notificationapi-com - type: LinkedIn url: https://www.linkedin.com/company/notificationapi - type: Website url: https://www.notificationapi.com/ - type: Documentation url: https://docs.notificationapi.com - type: Plans url: plans/notificationapi-plans-pricing.yml - type: RateLimits url: rate-limits/notificationapi-rate-limits.yml - type: FinOps url: finops/notificationapi-finops.yml maintainers: - FN: Kin Lane email: kin@apievangelist.com