How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

OpenZeppelin Notifications API

Notifications are responsible for showing the notifications related to the relayers.

OpenZeppelin Notifications API is one of 9 APIs that OpenZeppelin publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Notification. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, authentication docs, a GitHub repository, a changelog, and rate-limit docs.

This API exposes 5 operations across 2 paths, and defines 10 schemas. It is described by OpenAPI 3.1.0, at version 1.5.0.

Requests are made against the base URL https://defender-api.openzeppelin.com/v2.

5 operations 2 paths 10 schemas 1 DELETE2 GET1 PATCH1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.5.0
Base URL
https://defender-api.openzeppelin.com/v2
Authentication
HTTP Bearer
Terms of Service
Resource Areas
1

Authentication & Security 1

OpenZeppelin Notifications API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (bearer_auth).

Paths & Operations 5

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

Notifications 5

Notifications are responsible for showing the notifications related to the relayers.

GET
/api/v1/notifications
Notification routes implementation
listNotifications 2 params → 200400401500
POST
/api/v1/notifications
Creates a new notification.
createNotification body → 201400401409500
GET
/api/v1/notifications/{notification_id}
Retrieves details of a specific notification by ID.
getNotification 1 param → 200400401404500
DELETE
/api/v1/notifications/{notification_id}
Deletes a notification by ID.
deleteNotification 1 param → 200400401404500
PATCH
/api/v1/notifications/{notification_id}
Updates an existing notification.
updateNotification 1 param body → 200400401404500

Schemas 10

The contract defines 10 schemas that model the data the API accepts and returns. The most detailed are ApiResponse_String (5 properties), ApiResponse_NotificationResponse (5 properties), ApiResponse_Vec_NotificationResponse (5 properties), NotificationCreateRequest (4 properties). Each schema is shown below with its type and property counts.

LogEntry
object
2 properties 2 required
PluginMetadata
object
2 properties
NotificationType
string
Notification type enum used by both config file and API
NotificationUpdateRequest
object
Request structure for updating an existing notification
3 properties
ApiResponse_Vec_NotificationResponse
object
5 properties 1 required
LogLevel
string
ApiResponse_NotificationResponse
object
5 properties 1 required
NotificationCreateRequest
object
Request structure for creating a new notification
4 properties 1 required
PaginationMeta
object
3 properties 3 required
ApiResponse_String
object
5 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

openzeppelin-notifications-api-openapi.yml Raw ↑

Other APIs OpenZeppelin publishes across the network.

OpenZeppelin Monitor API
OpenZeppelin Contracts API Reference
OpenZeppelin Health API
OpenZeppelin Metrics API
OpenZeppelin Networks API
OpenZeppelin Plugins API
OpenZeppelin Relayers API
OpenZeppelin Signers API
Where this information came from

This is an independent, third-party profile of OpenZeppelin Notifications API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.