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

Zeplin Notifications API

The Notifications API from Zeplin — 2 operation(s) for notifications.

Zeplin Notifications API is one of 16 APIs that Zeplin 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, API documentation, authentication docs, and rate-limit docs.

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

Requests are made against a single base URL, https://api.zeplin.dev.

4 operations 2 paths 7 schemas 2 GET2 PATCH

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.2
API Version
1.38.0
Base URL
https://api.zeplin.io
Authentication
OAuth 2.0, HTTP Bearer
Contact
Resource Areas
1

Authentication & Security 2

Zeplin Notifications API declares 2 security schemes for authenticating requests. It supports OAuth 2.0 (OAuth2) using the authorizationCode flow. It accepts HTTP bearer tokens (JWT) (PersonalAccessToken). By default, every request must be authenticated.

Paths & Operations 4

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

Notifications 4
GET
/v1/users/me/notifications
Get user notifications
GetUserNotifications 4 params → 200
PATCH
/v1/users/me/notifications
Bulk update user notifications
UpdateUserNotifications 2 params body → 204
GET
/v1/users/me/notifications/{notification_id}
Get a notification of user
GetUserNotification 1 param → 200404
PATCH
/v1/users/me/notifications/{notification_id}
Update user notification
UpdateUserNotification 1 param body → 204404

Schemas 7

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

NotificationTypeEnum
string
NotificationUpdateBody
object
1 property 1 required
Notification
object
Notification objects have a polymorphic structure. They can be of various types and each type has a certain set of actions that describe the notification furth…
9 properties 8 required
ErrorResponse
object
3 properties 1 required
User
object
Basic info about Zeplin users. Zeplin API does not expose any personal information to third-party clients. For this reason, the email field is a Zeplin-only al…
6 properties 3 required
NotificationResource
object
The main object that this notification is related. It contains the ID of the object along with its type and partial data. The content of this object varies bet…
3 properties 3 required
NotificationActor
object
The actor of the change triggering this notification
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

zeplin-notifications-api-openapi.yml Raw ↑

Other APIs Zeplin publishes across the network.

Zeplin Authorization API
Zeplin Colors API
Zeplin Components API
Zeplin Connected Components API
Zeplin Design Tokens API
Zeplin Flows API
Zeplin Organizations API
Zeplin Projects API
Zeplin Screens API
Zeplin Spacing API
Zeplin Styleguides API
Zeplin TextStyles API