Replicated notifications API is one of 22 APIs that Replicated publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include notifications. The published artifact set on APIs.io includes an OpenAPI specification, authentication docs, and an API reference.
This API exposes
12 operations
across 10 paths,
and defines 14 schemas.
It is described by OpenAPI 2.0, at version 3.0.0.
Requests are made against the base URL https://api.replicated.com/vendor/v3.
12 operations10 paths14 schemas1 DELETE5 GET5 POST1 PUT
Metadata
The identity and technical contract details declared by the specification.
Replicated notifications API declares
1 security scheme
for authenticating requests.
An API key is passed in the header as Authorization (api_key).
Paths & Operations 12
Across 10 paths, the API surfaces 12 operations — 1 DELETE, 5 GET, 5 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.
notifications 12
POST
/notification_email/resend_verification
Resend verification email for an unverified email address.
resendVerificationEmail1 param→ 200400401403
POST
/notification_email/verify
Verify an email address using a verification code.
List all notification subscriptions for the current team.
listNotificationSubscriptions→ 200401403
POST
/notification_webhook/test
Test a webhook endpoint by sending a sample payload.
testWebhook1 param→ 200400401403
Schemas 14
The contract defines 14 schemas that model the data the API accepts and returns. The most detailed are NotificationSubscription (18 properties), TeamNotificationEventWithAttempts (15 properties), NotificationEventWithAttempts (13 properties), NotificationEventAttempt (11 properties). Each schema is shown below with its type and property counts.
PayloadField
object
Fields are returned as an ordered slice to preserve display order in the UI.
3 properties
NotificationEventAttempt
object
NotificationEventAttempt represents a delivery attempt for a notification event
11 properties
TestWebhookResponseBody
object
TestWebhookResponseBody contains the result of a webhook test
4 properties
SearchNotificationEventTypesResponse
object
SearchNotificationEventTypesResponse is the response for searching event types
2 properties
NotificationSubscription
object
NotificationSubscription represents a notification subscription
18 properties
FilterField
object
FilterField represents a filter field for an event type
6 properties
Actor
object
5 properties
Option
object
Option represents an option for select/multiselect fields
4 properties
CustomHeaderInput
object
CustomHeaderInput represents a custom HTTP header provided by the user (name + plaintext value)
2 properties
CustomHeaderMasked
object
CustomHeaderMasked represents a custom HTTP header with its value masked for API responses
2 properties
NotificationEventConfig
object
NotificationEventConfig represents an event configuration within a subscription
2 properties
NotificationEventWithAttempts
object
NotificationEventWithAttempts includes event details and all delivery attempts
13 properties
TeamNotificationEventWithAttempts
object
TeamNotificationEventWithAttempts includes notification event details, attempts, and subscription metadata for team-wide listing.
15 properties
EventTypeResponse
object
EventTypeResponse represents the JSON response for an event type
6 properties
Specification
The full machine-readable OpenAPI contract behind this narrative.
