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 Webhooks API

The Webhooks API from Zeplin — 8 operation(s) for webhooks.

Zeplin Webhooks API is one of 16 APIs that Zeplin publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

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

This API exposes 20 operations across 8 paths, and defines 22 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.

20 operations 8 paths 22 schemas 4 DELETE8 GET4 PATCH4 POST

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 Webhooks 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 20

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

Webhooks 20
GET
/v1/organizations/{organization_id}/webhooks
Get organization webhooks
GetOrganizationWebhooks 5 params → 200403404
POST
/v1/organizations/{organization_id}/webhooks
Create organization webhooks
CreateOrganizationWebhooks 1 param body → 200403422
GET
/v1/organizations/{organization_id}/webhooks/{webhook_id}
Get a webhook of organization
GetOrganizationWebhook 2 params → 200403404
DELETE
/v1/organizations/{organization_id}/webhooks/{webhook_id}
Delete a webhook of an organization
DeleteOrganizationWebhook 2 params → 204403404
PATCH
/v1/organizations/{organization_id}/webhooks/{webhook_id}
Update organization webhooks
UpdateOrganizationWebhooks 2 params body → 204403404422
GET
/v1/projects/{project_id}/webhooks
Get project webhooks
GetProjectWebhooks 5 params → 200403404422
POST
/v1/projects/{project_id}/webhooks
Create project webhooks
CreateProjectWebhooks 1 param body → 200403404422
GET
/v1/projects/{project_id}/webhooks/{webhook_id}
Get a webhook of project
GetProjectWebhook 2 params → 200403404422
DELETE
/v1/projects/{project_id}/webhooks/{webhook_id}
Delete a webhook of a project
DeleteProjectWebhook 2 params → 204403404422
PATCH
/v1/projects/{project_id}/webhooks/{webhook_id}
Update project webhooks
UpdateProjectWebhooks 2 params body → 204403404422
GET
/v1/styleguides/{styleguide_id}/webhooks
Get styleguide webhooks
GetStyleguideWebhooks 5 params → 200403404422
POST
/v1/styleguides/{styleguide_id}/webhooks
Create styleguide webhooks
CreateStyleguideWebhooks 1 param body → 200403404422
GET
/v1/styleguides/{styleguide_id}/webhooks/{webhook_id}
Get a webhook of styleguide
GetStyleguideWebhook 2 params → 200403404422
DELETE
/v1/styleguides/{styleguide_id}/webhooks/{webhook_id}
Delete a webhook of a styleguide
DeleteStyleguideWebhook 2 params → 204403404422
PATCH
/v1/styleguides/{styleguide_id}/webhooks/{webhook_id}
Update styleguide webhooks
UpdateStyleguideWebhooks 2 params body → 204403404422
GET
/v1/users/me/webhooks
Get user webhooks
GetUserWebhooks 4 params → 200
POST
/v1/users/me/webhooks
Create user webhooks
CreateUserWebhooks body → 200403422
GET
/v1/users/me/webhooks/{webhook_id}
Get a webhook of user
GetUserWebhook 1 param → 200404
DELETE
/v1/users/me/webhooks/{webhook_id}
Delete a webhook of a user
DeleteUserWebhook 1 param → 204403404
PATCH
/v1/users/me/webhooks/{webhook_id}
Update user webhooks
UpdateUserWebhooks 1 param body → 204403404422

Schemas 22

The contract defines 22 schemas that model the data the API accepts and returns. The most detailed are UserWebhook (13 properties), OrganizationWebhook (13 properties), ProjectWebhook (11 properties), StyleguideWebhook (11 properties). Each schema is shown below with its type and property counts.

ProjectWebhook
object
11 properties 9 required
OrganizationWebhookUpdateBody
object
7 properties
ProjectWebhookCreateBody
object
5 properties 3 required
OrganizationWebhookCreateBody
object
7 properties 5 required
WebhookStatusEnum
string
The status of the webhook
OrganizationWebhookEventEnum
string
ErrorResponse
object
3 properties 1 required
EntityReference
object
1 property 1 required
UserWebhookEventEnum
string
ZeplinApplication
object
5 properties 2 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
ProjectWebhookUpdateBody
object
5 properties
WebhookHealthEnum
string
The health of a webhook URL
UserWebhookUpdateBody
object
7 properties
UserWebhookCreateBody
object
7 properties 5 required
StyleguideWebhookEventEnum
string
OrganizationWebhook
object
13 properties 11 required
ProjectWebhookEventEnum
string
UserWebhook
object
13 properties 11 required
StyleguideWebhookUpdateBody
object
5 properties
StyleguideWebhookCreateBody
object
5 properties 3 required
StyleguideWebhook
object
11 properties 9 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

zeplin-webhooks-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 Notifications API
Zeplin Organizations API
Zeplin Projects API
Zeplin Screens API
Zeplin Spacing API
Zeplin Styleguides API