Zeplin integration guide
VerifiedHow to connect Zeplin to WEXTL and use its 1 trigger and 122 actions in your workflows. About Zeplin: Design handoff for teams with screens, components, design tokens, notes and members.
- 1 trigger
- 76 searches
- 46 actions
- Instant (webhooks)
- Auth: API key
- Auth: OAuth
AI-assisted documentation35 min read
This documentation is compiled from our integration source code, internal specs for Zeplin, its official API documentation and anonymized requests logs we collect from our support team[2].
Requirements
Get your Zeplin credentials
Zeplin - Personal Access Token
- Personal Access TokenpasswordRequired
In Zeplin open your Profile, then the Developer tab (app.zeplin.io/profile/developer), create a personal access token and paste it here. The token works for everything you can open in Zeplin.[1]
Zeplin - OAuth
You’ll be redirected to sign in and approve access. Your password is never shared with WEXTL.
Connect Zeplin in WEXTL
- Log in to your WEXTL account, add the Zeplin node module to your workflow, and click Create new credential.Instant triggers use webhooks. Click Create a webhook first when adding one, then create the credential.
- Optional: In the Credential name field, enter a name for the credential.
- Enter the authentication credentials you copied from your Zeplin account, or follow the on-screen instructions to create the credential.
- If prompted, authenticate your account and confirm access.
- If you want to make changes to your credential in the future, follow the steps in Manage credentials →
Zeplin triggers and actions on WEXTL
The list below is a reference of every Zeplin node module the integration supports. You will be able to pick any of them on the workflow canvas while building automations.
Open any Zeplin node module below to inspect its input parameters, outputs, and connection requirements.
Watch Events (Instant)
TriggerInstant trigger for Zeplin events.
| Field | Type |
|---|---|
| Event | text |
| Action | text |
| Timestamp | number |
| Resource | object |
| ID | text |
| Type | text |
| Data | text |
| Context | text |
Get a Project
SearchPlatform and description of a project.
| Field | Type |
|---|---|
ProjectRequired | choice |
| Field | Type |
|---|---|
| ID | text |
| Name | text |
| Description | text |
| Platform | text |
| Thumbnail | text |
| Status | text |
| Scene URL | text |
| Created | number |
| Updated | number |
| Number Of Members | number |
6other output fields
Get a Project Component
SearchComponent data, with optional version.
| Field | Type |
|---|---|
ProjectRequired | choice |
Component IDRequired | text |
| Include Latest Version | boolean |
| Include Linked Styleguides | boolean |
| Field | Type |
|---|---|
| ID | text |
| Name | text |
| Description | text |
| Image | object |
| Width | number |
| Height | number |
| Original URL | text |
| Thumbnails | object |
| Created | number |
| Updated | number |
| Section | object |
| ID | text |
| Group | object |
| Source | object |
| Project | object |
| Variant Properties | array |
| ID | text |
| Name | text |
| Value | text |
Get a Project Flow Board
SearchSize summary of a flow board.
| Field | Type |
|---|---|
ProjectRequired | choice |
Flow Board IDRequired | text |
| Field | Type |
|---|---|
| ID | text |
| Name | text |
| Number Of Connectors | number |
| Number Of Nodes | number |
| Number Of Groups | number |
Get a Project Flow Board Connector
SearchLink between two flow board nodes.
| Field | Type |
|---|---|
ProjectRequired | choice |
Flow Board IDRequired | text |
Connector IDRequired | text |
| Field | Type |
|---|---|
| ID | text |
| Type | text |
| Start | object |
| Node | object |
| Node Position | object |
| End | object |
| Node | object |
| Node Position | object |
| Label | object |
Get a Project Flow Board Node
SearchWhere one node sits on a user-flow diagram.
| Field | Type |
|---|---|
ProjectRequired | choice |
Flow Board IDRequired | text |
Node IDRequired | text |
| Field | Type |
|---|---|
| ID | text |
| Type | text |
| Screen | object |
| ID | text |
| Position | object |
| X | number |
| Y | number |
Get a Project Webhook
SearchWho made a project hook and when.
| Field | Type |
|---|---|
ProjectRequired | choice |
Webhook IDRequired | text |
| Field | Type |
|---|---|
| ID | text |
| Name | text |
| Status | text |
| Created | number |
| Created By | object |
| ID | text |
| text | |
| Updated | number |
| Updated By | object |
| ID | text |
| text | |
| URL | text |
| URL Health | text |
| Events | array |
Get a Screen
SearchName, tags and image of a screen.
| Field | Type |
|---|---|
ProjectRequired | choice |
ScreenRequired | choice |
| Field | Type |
|---|---|
| ID | text |
| Name | text |
| Description | text |
| Tags | array |
| Image | object |
| Width | number |
| Height | number |
| Original URL | text |
| Thumbnails | object |
| Created | number |
| Updated | number |
| Number Of Notes | number |
| Number Of Versions | number |
| Number Of Annotations | number |
2other output fields
Get a Screen Annotation
SearchText and position of an annotation.
| Field | Type |
|---|---|
ProjectRequired | choice |
ScreenRequired | choice |
Annotation IDRequired | text |
| Field | Type |
|---|---|
| ID | text |
| Content | text |
| Type | object |
| ID | text |
| Name | text |
| Color | object |
| Position | object |
| X | number |
| Y | number |
| Creator | object |
| ID | text |
| text | |
| Username | text |
| Emotar | text |
| Avatar | text |
| Last Seen | number |
| Updated By | object |
| ID | text |
| text | |
| Username | text |
| Emotar | text |
| Avatar | text |
| Last Seen | number |
| Updated | number |
| Created | number |
Get a Screen Note
SearchStatus and position of a note.
| Field | Type |
|---|---|
ProjectRequired | choice |
ScreenRequired | choice |
NoteRequired | choice |
| Field | Type |
|---|---|
| ID | text |
| Created | number |
| Order | number |
| Status | text |
| Position | object |
| X | number |
| Y | number |
| X Start | number |
| Y Start | number |
| Color | object |
| Name | text |
| R | number |
| G | number |
| B | number |
| A | number |
| Creator | object |
| ID | text |
| text | |
| Username | text |
| Emotar | text |
| Avatar | text |
| Last Seen | number |
| Comments | array |
| ID | text |
| Author | object |
| Content | text |
| Updated | number |
| Reactions | array |
| Screen Version ID | text |
Get a Screen Section
SearchName and parent of a screen section.
| Field | Type |
|---|---|
ProjectRequired | choice |
Section IDRequired | text |
| Field | Type |
|---|---|
| ID | text |
| Created | number |
| Name | text |
| Parent | object |
| ID | text |
Get a Screen Variant
SearchGrouped screen variants under one name.
| Field | Type |
|---|---|
ProjectRequired | choice |
Variant IDRequired | text |
| Field | Type |
|---|---|
| ID | text |
| Name | text |
| Variants | array |
| Screen ID | text |
| Value | text |
Get a Screen Version
SearchHistoric image of a screen.
| Field | Type |
|---|---|
ProjectRequired | choice |
ScreenRequired | choice |
Version IDRequired | text |
| Field | Type |
|---|---|
| ID | text |
| Creator | object |
| ID | text |
| text | |
| Username | text |
| Emotar | text |
| Avatar | text |
| Last Seen | number |
| Commit | object |
| Message | text |
| Author | object |
| Color | object |
| Image URL | text |
| Thumbnails | object |
| Small | text |
| Medium | text |
| Large | text |
| Width | number |
| Height | number |
| Density Scale | number |
| Source | text |
| Source File URL | text |
4other output fields
Get a Styleguide
SearchPlatform, status and description of a styleguide.
| Field | Type |
|---|---|
StyleguideRequired | choice |
| Linked Project | text |
| Linked Styleguide | text |
| Field | Type |
|---|---|
| ID | text |
| Name | text |
| Description | text |
| Platform | text |
| Thumbnail | text |
| Status | text |
| Created | number |
| Updated | number |
| Number Of Members | number |
| Number Of Components | number |
4other output fields
Get a Styleguide Component
SearchComponent data with optional newest render.
| Field | Type |
|---|---|
StyleguideRequired | choice |
Component IDRequired | text |
| Linked Project | text |
| Linked Styleguide | text |
| Include Latest Version | boolean |
| Include Linked Styleguides | boolean |
| Field | Type |
|---|---|
| ID | text |
| Name | text |
| Description | text |
| Image | object |
| Width | number |
| Height | number |
| Original URL | text |
| Thumbnails | object |
| Created | number |
| Updated | number |
| Section | object |
| ID | text |
| Group | object |
| Source | object |
| Project | object |
| Variant Properties | array |
| ID | text |
| Name | text |
| Value | text |
Get a Styleguide Webhook
SearchCreator and status of a styleguide hook.
| Field | Type |
|---|---|
StyleguideRequired | choice |
Webhook IDRequired | text |
| Field | Type |
|---|---|
| ID | text |
| Name | text |
| Status | text |
| Created | number |
| Created By | object |
| ID | text |
| text | |
| Updated | number |
| Updated By | object |
| ID | text |
| text | |
| URL | text |
| URL Health | text |
| Events | array |
Get a User Notification
SearchRead state of a notification.
| Field | Type |
|---|---|
Notification IDRequired | text |
| Field | Type |
|---|---|
| ID | text |
| Timestamp | number |
| Type | text |
| Action | text |
| Is Read | boolean |
| Resource | object |
| ID | text |
| Type | text |
| Extra | object |
| Context | object |
| Project | object |
| Actor | object |
| User | object |
Get a User Webhook
SearchSettings of a personal hook.
| Field | Type |
|---|---|
Webhook IDRequired | text |
| Field | Type |
|---|---|
| ID | text |
| Name | text |
| Status | text |
| Created | number |
| Created By | object |
| ID | text |
| text | |
| Updated | number |
| Updated By | object |
| ID | text |
| text | |
| URL | text |
| URL Health | text |
| Events | array |
2other output fields
Get an Organization
SearchOrganization name and member list.
| Field | Type |
|---|---|
OrganizationRequired | choice |
| Field | Type |
|---|---|
| ID | text |
| Name | text |
| Members | array |
| User | object |
| Role | text |
| Tags | array |
| Restricted | boolean |
| Invited | number |
Get an Organization Webhook
SearchWho made an organization hook and when.
| Field | Type |
|---|---|
OrganizationRequired | choice |
Webhook IDRequired | text |
| Field | Type |
|---|---|
| ID | text |
| Name | text |
| Status | text |
| Created | number |
| Created By | object |
| ID | text |
| text | |
| Updated | number |
| Updated By | object |
| ID | text |
| text | |
| URL | text |
| URL Health | text |
| Events | array |
2other output fields
Get Organization Billing
SearchSeat usage of an organization.
| Field | Type |
|---|---|
OrganizationRequired | choice |
| Field | Type |
|---|---|
| Total Seat Count | number |
| Used Seat Count | number |
Get Project Design Tokens
SearchColors, spacing and type tokens for code.
| Field | Type |
|---|---|
ProjectRequired | choice |
| Include Linked Styleguides | boolean |
| Token Name Case | choice |
| Field | Type |
|---|---|
| Colors | object |
| Yellow | object |
| Light-yellow | object |
| Spacing | object |
| Xs-spacing | object |
| Text Styles | object |
| Header-h1 | object |
| Header-h2 | object |
Get Styleguide Design Tokens
SearchShared tokens ready for code generation.
| Field | Type |
|---|---|
StyleguideRequired | choice |
| Include Linked Styleguides | boolean |
| Token Name Case | choice |
| Field | Type |
|---|---|
| Colors | object |
| Yellow | object |
| Light-yellow | object |
| Spacing | object |
| Xs-spacing | object |
| Text Styles | object |
| Header-h1 | object |
| Header-h2 | object |
Get the Current User
SearchIdentity of the credential owner.
| Field | Type |
|---|---|
| ID | text |
| text | |
| Username | text |
| Emotar | text |
| Avatar | text |
| Last Seen | number |
Get the Latest Screen Version
SearchMost recent image upload of a screen.
| Field | Type |
|---|---|
ProjectRequired | choice |
ScreenRequired | choice |
| Field | Type |
|---|---|
| ID | text |
| Creator | object |
| ID | text |
| text | |
| Username | text |
| Emotar | text |
| Avatar | text |
| Last Seen | number |
| Commit | object |
| Message | text |
| Author | object |
| Color | object |
| Image URL | text |
| Thumbnails | object |
| Small | text |
| Medium | text |
| Large | text |
| Width | number |
| Height | number |
| Density Scale | number |
| Source | text |
| Source File URL | text |
4other output fields
Get the Latest Version of a Project Component
SearchCurrent image of a project component.
| Field | Type |
|---|---|
ProjectRequired | choice |
Component IDRequired | text |
| Include Linked Styleguides | boolean |
| Field | Type |
|---|---|
| ID | text |
| Created | number |
| Creator | object |
| ID | text |
| text | |
| Username | text |
| Emotar | text |
| Avatar | text |
| Last Seen | number |
| Image URL | text |
| Thumbnails | object |
| Small | text |
| Medium | text |
| Large | text |
| Width | number |
| Height | number |
| Density Scale | number |
| Source | text |
| Source File URL | text |
4other output fields
Get the Latest Version of a Styleguide Component
SearchCurrent render of a shared component.
| Field | Type |
|---|---|
StyleguideRequired | choice |
Component IDRequired | text |
| Linked Project | text |
| Linked Styleguide | text |
| Include Linked Styleguides | boolean |
| Field | Type |
|---|---|
| ID | text |
| Created | number |
| Creator | object |
| ID | text |
| text | |
| Username | text |
| Emotar | text |
| Avatar | text |
| Last Seen | number |
| Image URL | text |
| Thumbnails | object |
| Small | text |
| Medium | text |
| Large | text |
| Width | number |
| Height | number |
| Density Scale | number |
| Source | text |
| Source File URL | text |
4other output fields
List Organization Aliens
SearchAlien-role accounts in an organization.
| Field | Type |
|---|---|
OrganizationRequired | choice |
| Field | Type |
|---|---|
| ID | text |
| text | |
| Username | text |
| Emotar | text |
| Avatar | text |
| Last Seen | number |
List Organization Member Projects
SearchProjects a teammate was added to.
| Field | Type |
|---|---|
OrganizationRequired | choice |
MemberRequired | choice |
LimitRequired | number |
| Field | Type |
|---|---|
| ID | text |
| Name | text |
| Description | text |
| Platform | text |
| Thumbnail | text |
| Status | text |
| Scene URL | text |
| Created | number |
| Updated | number |
| Number Of Members | number |
9other output fields
List Organization Member Styleguides
SearchStyleguides a teammate has joined.
| Field | Type |
|---|---|
OrganizationRequired | choice |
MemberRequired | choice |
LimitRequired | number |
| Field | Type |
|---|---|
| ID | text |
| Name | text |
| Description | text |
| Platform | text |
| Thumbnail | text |
| Status | text |
| Created | number |
| Updated | number |
| Number Of Members | number |
| Number Of Components | number |
4other output fields
List Organization Members
SearchRoster with roles and tags.
| Field | Type |
|---|---|
OrganizationRequired | choice |
LimitRequired | number |
| Handle | array |
| Item | text |
| Field | Type |
|---|---|
| User | object |
| ID | text |
| text | |
| Username | text |
| Emotar | text |
| Avatar | text |
| Last Seen | number |
| Role | text |
| Tags | array |
| Restricted | boolean |
| Invited | number |
List Organization Projects
SearchEverything an organization is designing.
| Field | Type |
|---|---|
OrganizationRequired | choice |
LimitRequired | number |
| Field | Type |
|---|---|
| ID | text |
| Name | text |
| Description | text |
| Platform | text |
| Thumbnail | text |
| Status | text |
| Created | number |
| Updated | number |
| Organization | object |
| ID | text |
| Name | text |
| Logo | text |
| Workflow Status | object |
| ID | text |
| Name | text |
| Color | object |
8other output fields
List Organization Styleguides
SearchStyleguides owned by one organization account.
| Field | Type |
|---|---|
OrganizationRequired | choice |
LimitRequired | number |
| Field | Type |
|---|---|
| ID | text |
| Name | text |
| Description | text |
| Platform | text |
| Thumbnail | text |
| Status | text |
| Created | number |
| Updated | number |
| Organization | object |
| ID | text |
| Name | text |
| Logo | text |
| Number Of Members | number |
6other output fields
List Organization Webhooks
SearchHook deliveries and their URL health.
| Field | Type |
|---|---|
OrganizationRequired | choice |
LimitRequired | number |
| Status | choice |
| URL Health | choice |
| Field | Type |
|---|---|
| ID | text |
| Name | text |
| Status | text |
| Created | number |
| Created By | object |
| ID | text |
| text | |
| Updated | number |
| Updated By | object |
| ID | text |
| text | |
| URL | text |
| URL Health | text |
| Events | array |
2other output fields
List Organization Workflow Statuses
SearchStatus labels used in project workflows.
| Field | Type |
|---|---|
OrganizationRequired | choice |
| Field | Type |
|---|---|
| ID | text |
| Name | text |
| Color | object |
| Name | text |
| R | number |
| G | number |
| B | number |
| A | number |
List Organizations
SearchOrganizations your account is part of.
| Field | Type |
|---|---|
| Role | choice |
| Field | Type |
|---|---|
| ID | text |
| Name | text |
| Logo | text |
List Project Colors
SearchSwatches saved in a project.
| Field | Type |
|---|---|
ProjectRequired | choice |
LimitRequired | number |
| Include Linked Styleguides | boolean |
| Field | Type |
|---|---|
| ID | text |
| Source ID | text |
| Created | number |
| Name | text |
| R | number |
| G | number |
| B | number |
| A | number |
| Variable Info | object |
| Source ID | text |
| Collection Source ID | text |
| Source | object |
| Project | object |
List Project Component Sections
SearchComponent sections grouped under project pages.
| Field | Type |
|---|---|
ProjectRequired | choice |
LimitRequired | number |
| Page ID | text |
| Field | Type |
|---|---|
| ID | text |
| Created | number |
| Name | text |
| Groups | array |
| ID | text |
| Created | number |
| Name | text |
| Variant | object |
| Properties | array |
| Source ID | text |
List Project Components
SearchReusable pieces inside a project.
| Field | Type |
|---|---|
ProjectRequired | choice |
LimitRequired | number |
| Section ID | text |
| Sort | choice |
| Include Latest Version | boolean |
| Include Linked Styleguides | boolean |
| Field | Type |
|---|---|
| ID | text |
| Name | text |
| Description | text |
| Image | object |
| Width | number |
| Height | number |
| Original URL | text |
| Thumbnails | object |
| Created | number |
| Updated | number |
| Section | object |
| ID | text |
| Group | object |
| Source | object |
| Project | object |
| Variant Properties | array |
| ID | text |
| Name | text |
| Value | text |
List Project Connected Components
SearchDesign pieces mapped to source code.
| Field | Type |
|---|---|
ProjectRequired | choice |
LimitRequired | number |
| Include Linked Styleguides | boolean |
| Field | Type |
|---|---|
| Components | array |
| ID | text |
| Name | text |
| Description | text |
| Code | object |
| Snippet | text |
| Language | text |
| Links | array |
| Type | text |
| URL | text |
| Name | text |
List Project Flow Board Connectors
SearchConnectors between flow board nodes.
| Field | Type |
|---|---|
ProjectRequired | choice |
Flow Board IDRequired | text |
LimitRequired | number |
| Starting Node ID | text |
| Ending Node ID | text |
| Field | Type |
|---|---|
| ID | text |
| Type | text |
| Start | object |
| Node | object |
| Node Position | object |
| End | object |
| Node | object |
| Node Position | object |
| Label | object |
List Project Flow Board Groups
SearchColored clusters on a user flow.
| Field | Type |
|---|---|
ProjectRequired | choice |
Flow Board IDRequired | text |
| Field | Type |
|---|---|
| ID | text |
| Created | number |
| Name | text |
| Color | object |
| Source ID | text |
| R | number |
| G | number |
| B | number |
| A | number |
List Project Flow Board Nodes
SearchNodes laid out on a user flow.
| Field | Type |
|---|---|
ProjectRequired | choice |
Flow Board IDRequired | text |
LimitRequired | number |
| Group ID | text |
| Field | Type |
|---|---|
| ID | text |
| Type | text |
| Screen | object |
| ID | text |
| Position | object |
| X | number |
| Y | number |
List Project Flow Boards
SearchUser-flow diagrams and their size.
| Field | Type |
|---|---|
ProjectRequired | choice |
| Field | Type |
|---|---|
| ID | text |
| Name | text |
| Number Of Connectors | number |
| Number Of Nodes | number |
| Number Of Groups | number |
List Project Members
SearchCollaborators and roles on a project.
| Field | Type |
|---|---|
ProjectRequired | choice |
LimitRequired | number |
| Field | Type |
|---|---|
| User | object |
| ID | text |
| text | |
| Username | text |
| Emotar | text |
| Avatar | text |
| Last Seen | number |
| Role | text |
List Project Pages
SearchPage names and types inside a project.
| Field | Type |
|---|---|
ProjectRequired | choice |
LimitRequired | number |
| Field | Type |
|---|---|
| ID | text |
| Created | number |
| Name | text |
| Type | text |
| Description | text |
| Component Sections | array |
List Project Screens
SearchAll designs uploaded to a project.
| Field | Type |
|---|---|
ProjectRequired | choice |
LimitRequired | number |
| Section ID | choice |
| Sort | choice |
| Field | Type |
|---|---|
| ID | text |
| Name | text |
| Description | text |
| Tags | array |
| Image | object |
| Width | number |
| Height | number |
| Original URL | text |
| Thumbnails | object |
| Created | number |
| Updated | number |
| Number Of Notes | number |
| Number Of Versions | number |
| Number Of Annotations | number |
2other output fields
List Project Spacing Sections
SearchGroupings for spacing tokens.
| Field | Type |
|---|---|
ProjectRequired | choice |
LimitRequired | number |
| Field | Type |
|---|---|
| ID | text |
List Project Spacing Tokens
SearchSpacing scale entries by ID.
| Field | Type |
|---|---|
ProjectRequired | choice |
LimitRequired | number |
| Include Linked Styleguides | boolean |
| Field | Type |
|---|---|
| ID | text |
List Project Text Styles
SearchFonts and type presets in a project.
| Field | Type |
|---|---|
ProjectRequired | choice |
LimitRequired | number |
| Include Linked Styleguides | boolean |
| Field | Type |
|---|---|
| ID | text |
| Name | text |
| Created | number |
| Postscript Name | text |
| Font Family | text |
| Font Size | number |
| Font Weight | number |
| Font Style | text |
| Line Height | number |
| Font Stretch | number |
3other output fields
List Project Variable Collections
SearchDesign variable sets stored in a project.
| Field | Type |
|---|---|
ProjectRequired | choice |
LimitRequired | number |
| Include Linked Styleguides | boolean |
| Field | Type |
|---|---|
| ID | text |
| Created | number |
| Name | text |
| Source ID | text |
| Modes | object |
| Summary | text |
| Value | object |
| Groups | object |
| Summary | text |
| Value | object |
List Project Webhooks
SearchEvent hooks watching a project.
| Field | Type |
|---|---|
ProjectRequired | choice |
LimitRequired | number |
| Status | choice |
| URL Health | choice |
| Field | Type |
|---|---|
| ID | text |
| Name | text |
| Status | text |
| Created | number |
| Created By | object |
| ID | text |
| text | |
| Updated | number |
| Updated By | object |
| ID | text |
| text | |
| URL | text |
| URL Health | text |
| Events | array |
List Projects
SearchYour projects, scoped to a workspace.
| Field | Type |
|---|---|
LimitRequired | number |
| Workspace | text |
| Status | choice |
| Field | Type |
|---|---|
| ID | text |
| Name | text |
| Description | text |
| Platform | text |
| Thumbnail | text |
| Status | text |
| Scene URL | text |
| Created | number |
| Updated | number |
| Number Of Members | number |
9other output fields
List Screen Annotation Note Types
SearchAnnotation categories of a project.
| Field | Type |
|---|---|
ProjectRequired | choice |
| Field | Type |
|---|---|
| ID | text |
| Name | text |
| Color | object |
| Name | text |
| R | number |
| G | number |
| B | number |
| A | number |
List Screen Annotations
SearchPinned commentary on a design.
| Field | Type |
|---|---|
ProjectRequired | choice |
ScreenRequired | choice |
LimitRequired | number |
| Field | Type |
|---|---|
| ID | text |
| Content | text |
| Type | object |
| ID | text |
| Name | text |
| Color | object |
| Position | object |
| X | number |
| Y | number |
| Creator | object |
| ID | text |
| text | |
| Username | text |
| Emotar | text |
| Avatar | text |
| Last Seen | number |
| Updated By | object |
| ID | text |
| text | |
| Username | text |
| Emotar | text |
| Avatar | text |
| Last Seen | number |
| Updated | number |
| Created | number |
List Screen Components
SearchBuilding blocks used in one design.
| Field | Type |
|---|---|
ProjectRequired | choice |
ScreenRequired | choice |
LimitRequired | number |
| Include Latest Version | boolean |
| Include Linked Styleguides | boolean |
| Field | Type |
|---|---|
| ID | text |
| Name | text |
| Description | text |
| Image | object |
| Width | number |
| Height | number |
| Original URL | text |
| Thumbnails | object |
| Created | number |
| Updated | number |
| Section | object |
| ID | text |
| Group | object |
| Source | object |
| Project | object |
| Variant Properties | array |
| ID | text |
| Name | text |
| Value | text |
List Screen Notes
SearchReview feedback pinned to one screen.
| Field | Type |
|---|---|
ProjectRequired | choice |
ScreenRequired | choice |
LimitRequired | number |
| Field | Type |
|---|---|
| ID | text |
| Created | number |
| Order | number |
| Status | text |
| Position | object |
| X | number |
| Y | number |
| X Start | number |
| Y Start | number |
| Color | object |
| Name | text |
| R | number |
| G | number |
| B | number |
| A | number |
| Creator | object |
| ID | text |
| text | |
| Username | text |
| Emotar | text |
| Avatar | text |
| Last Seen | number |
| Comments | array |
| ID | text |
| Author | object |
| Content | text |
| Updated | number |
| Reactions | array |
| Screen Version ID | text |
List Screen Sections
SearchScreen folders and their nesting.
| Field | Type |
|---|---|
ProjectRequired | choice |
LimitRequired | number |
| Field | Type |
|---|---|
| ID | text |
| Created | number |
| Name | text |
| Parent | object |
| ID | text |
List Screen Variants
SearchAlternative designs of a screen.
| Field | Type |
|---|---|
ProjectRequired | choice |
LimitRequired | number |
| Field | Type |
|---|---|
| ID | text |
| Name | text |
| Variants | array |
| Screen ID | text |
| Value | text |
List Screen Versions
SearchUpload history of a screen.
| Field | Type |
|---|---|
ProjectRequired | choice |
ScreenRequired | choice |
LimitRequired | number |
| Field | Type |
|---|---|
| ID | text |
| Creator | object |
| ID | text |
| text | |
| Username | text |
| Emotar | text |
| Avatar | text |
| Last Seen | number |
| Commit | object |
| Message | text |
| Author | object |
| Color | object |
| Image URL | text |
| Thumbnails | object |
| Small | text |
| Medium | text |
| Large | text |
| Width | number |
| Height | number |
| Density Scale | number |
| Source | text |
| Source File URL | text |
2other output fields
List Styleguide Colors
SearchSwatches in a shared library.
| Field | Type |
|---|---|
StyleguideRequired | choice |
LimitRequired | number |
| Linked Project | text |
| Linked Styleguide | text |
| Include Linked Styleguides | boolean |
| Field | Type |
|---|---|
| ID | text |
| Source ID | text |
| Created | number |
| Name | text |
| R | number |
| G | number |
| B | number |
| A | number |
| Variable Info | object |
| Source ID | text |
| Collection Source ID | text |
| Source | object |
| Project | object |
List Styleguide Component Sections
SearchFolders of shared components.
| Field | Type |
|---|---|
StyleguideRequired | choice |
LimitRequired | number |
| Page ID | text |
| Linked Project | text |
| Linked Styleguide | text |
| Field | Type |
|---|---|
| ID | text |
List Styleguide Components
SearchReusable parts of a styleguide.
| Field | Type |
|---|---|
StyleguideRequired | choice |
LimitRequired | number |
| Section ID | text |
| Sort | choice |
| Linked Project | text |
| Linked Styleguide | text |
| Include Linked Styleguides | boolean |
| Include Latest Version | boolean |
| Field | Type |
|---|---|
| ID | text |
| Name | text |
| Description | text |
| Image | object |
| Width | number |
| Height | number |
| Original URL | text |
| Thumbnails | object |
| Created | number |
| Updated | number |
| Section | object |
| ID | text |
| Group | object |
| Source | object |
| Project | object |
| Variant Properties | array |
| ID | text |
| Name | text |
| Value | text |
List Styleguide Connected Components
SearchShared pieces mapped to source code.
| Field | Type |
|---|---|
StyleguideRequired | choice |
LimitRequired | number |
| Linked Project | text |
| Linked Styleguide | text |
| Include Linked Styleguides | boolean |
| Field | Type |
|---|---|
| Components | array |
| ID | text |
| Name | text |
| Description | text |
| Code | object |
| Snippet | text |
| Language | text |
| Links | array |
| Type | text |
| URL | text |
| Name | text |
List Styleguide Linked Projects
SearchProjects that pull from a shared styleguide.
| Field | Type |
|---|---|
StyleguideRequired | choice |
LimitRequired | number |
| Field | Type |
|---|---|
| ID | text |
| Name | text |
| Description | text |
| Platform | text |
| Thumbnail | text |
| Status | text |
| Scene URL | text |
| Created | number |
| Updated | number |
| Number Of Members | number |
6other output fields
List Styleguide Members
SearchCollaborators of a styleguide and their roles.
| Field | Type |
|---|---|
StyleguideRequired | choice |
LimitRequired | number |
| Linked Project | text |
| Linked Styleguide | text |
| Field | Type |
|---|---|
| User | object |
| ID | text |
| text | |
| Username | text |
| Emotar | text |
| Avatar | text |
| Last Seen | number |
| Role | text |
List Styleguide Pages
SearchPages, with name and type, of a styleguide.
| Field | Type |
|---|---|
StyleguideRequired | choice |
LimitRequired | number |
| Field | Type |
|---|---|
| ID | text |
| Created | number |
| Name | text |
| Type | text |
| Description | text |
| Component Sections | array |
List Styleguide Spacing Sections
SearchSpacing token sections by ID.
| Field | Type |
|---|---|
StyleguideRequired | choice |
LimitRequired | number |
| Linked Project | text |
| Linked Styleguide | text |
| Field | Type |
|---|---|
| ID | text |
List Styleguide Spacing Tokens
SearchSpacing token IDs saved in a styleguide.
| Field | Type |
|---|---|
StyleguideRequired | choice |
LimitRequired | number |
| Linked Project | text |
| Linked Styleguide | text |
| Include Linked Styleguides | boolean |
| Field | Type |
|---|---|
| ID | text |
List Styleguide Text Styles
SearchTypography presets saved in a styleguide.
| Field | Type |
|---|---|
StyleguideRequired | choice |
LimitRequired | number |
| Linked Project | text |
| Linked Styleguide | text |
| Include Linked Styleguides | boolean |
| Field | Type |
|---|---|
| ID | text |
| Name | text |
| Created | number |
| Postscript Name | text |
| Font Family | text |
| Font Size | number |
| Font Weight | number |
| Font Style | text |
| Line Height | number |
| Font Stretch | number |
3other output fields
List Styleguide Variable Collections
SearchDesign variable sets of a styleguide.
| Field | Type |
|---|---|
StyleguideRequired | choice |
LimitRequired | number |
| Include Linked Styleguides | boolean |
| Field | Type |
|---|---|
| ID | text |
| Created | number |
| Name | text |
| Source ID | text |
| Modes | object |
| Summary | text |
| Value | object |
| Groups | object |
| Summary | text |
| Value | object |
List Styleguide Webhooks
SearchWebhooks delivering styleguide events.
| Field | Type |
|---|---|
StyleguideRequired | choice |
LimitRequired | number |
| Status | choice |
| URL Health | choice |
| Field | Type |
|---|---|
| ID | text |
| Name | text |
| Status | text |
| Created | number |
| Created By | object |
| ID | text |
| text | |
| Updated | number |
| Updated By | object |
| ID | text |
| text | |
| URL | text |
| URL Health | text |
| Events | array |
List Styleguides
SearchEvery styleguide reachable by your account.
| Field | Type |
|---|---|
LimitRequired | number |
| Workspace | text |
| Status | choice |
| Linked Project | text |
| Linked Styleguide | text |
| Field | Type |
|---|---|
| ID | text |
| Name | text |
| Description | text |
| Platform | text |
| Thumbnail | text |
| Status | text |
| Created | number |
| Updated | number |
| Number Of Members | number |
| Number Of Components | number |
4other output fields
List User Notifications
SearchYour inbox of Zeplin alerts.
| Field | Type |
|---|---|
LimitRequired | number |
| Read | choice |
| Type | choice |
| Field | Type |
|---|---|
| ID | text |
| Timestamp | number |
| Type | text |
| Action | text |
| Is Read | boolean |
| Resource | object |
| ID | text |
| Type | text |
| Extra | object |
| Context | object |
| Project | object |
| Actor | object |
| User | object |
List User Projects
SearchWork you take part in.
| Field | Type |
|---|---|
LimitRequired | number |
| Status | choice |
| Field | Type |
|---|---|
| ID | text |
| Name | text |
| Description | text |
| Platform | text |
| Thumbnail | text |
| Status | text |
| Scene URL | text |
| Created | number |
| Updated | number |
| Number Of Members | number |
6other output fields
List User Styleguides
SearchStyleguides you take part in.
| Field | Type |
|---|---|
LimitRequired | number |
| Status | choice |
| Field | Type |
|---|---|
| ID | text |
| Name | text |
| Description | text |
| Platform | text |
| Thumbnail | text |
| Status | text |
| Created | number |
| Updated | number |
| Number Of Members | number |
| Number Of Components | number |
4other output fields
List User Webhooks
SearchPersonal event hooks you made.
| Field | Type |
|---|---|
LimitRequired | number |
| Status | choice |
| URL Health | choice |
| Field | Type |
|---|---|
| ID | text |
| Name | text |
| Status | text |
| Created | number |
| Created By | object |
| ID | text |
| text | |
| Updated | number |
| Updated By | object |
| ID | text |
| text | |
| URL | text |
| URL Health | text |
| Events | array |
2other output fields
Create a Project Color
ActionPalette entry with RGBA values.
| Field | Type |
|---|---|
ProjectRequired | choice |
NameRequired | text |
RedRequired | number |
GreenRequired | number |
BlueRequired | number |
AlphaRequired | number |
| Source ID | text |
| Field | Type |
|---|---|
| ID | text |
Create a Project Webhook
ActionEvent delivery to a URL.
| Field | Type |
|---|---|
ProjectRequired | choice |
URLRequired | text |
SecretRequired | secret |
EventsRequired | choice |
| Name | text |
| Status | choice |
| Field | Type |
|---|---|
| ID | text |
Create a Screen
ActionScreen from an uploaded image.
| Field | Type |
|---|---|
ProjectRequired | choice |
NameRequired | text |
ImageRequired | text |
| Description | text |
| Commit Message | text |
| Commit Color | choice |
| Tags | array |
| Item | text |
| Screen Section | choice |
| Field | Type |
|---|---|
| ID | text |
Create a Screen Annotation
ActionAnnotation pinned to a screen position.
| Field | Type |
|---|---|
ProjectRequired | choice |
ScreenRequired | choice |
ContentRequired | text |
PositionRequired | object |
XRequired | number |
YRequired | number |
| Type | text |
| Field | Type |
|---|---|
| ID | text |
Create a Screen Comment
ActionReply added to a screen note.
| Field | Type |
|---|---|
ProjectRequired | choice |
ScreenRequired | choice |
NoteRequired | choice |
ContentRequired | text |
| Field | Type |
|---|---|
| ID | text |
Create a Screen Note
ActionReview note placed over a design.
| Field | Type |
|---|---|
ProjectRequired | choice |
ScreenRequired | choice |
ContentRequired | text |
PositionRequired | object |
XRequired | number |
YRequired | number |
| X Start | number |
| Y Start | number |
ColorRequired | choice |
| Field | Type |
|---|---|
| ID | text |
Create a Screen Version
ActionNewer image for an existing screen.
| Field | Type |
|---|---|
ProjectRequired | choice |
ScreenRequired | choice |
ImageRequired | text |
| Commit Message | text |
| Commit Color | choice |
| Field | Type |
|---|---|
| ID | text |
Create a Styleguide Color
ActionShared swatch for a styleguide.
| Field | Type |
|---|---|
StyleguideRequired | choice |
NameRequired | text |
RedRequired | number |
GreenRequired | number |
BlueRequired | number |
AlphaRequired | number |
| Source ID | text |
| Field | Type |
|---|---|
| ID | text |
Create a Styleguide Webhook
ActionEvent feed for a styleguide.
| Field | Type |
|---|---|
StyleguideRequired | choice |
URLRequired | text |
SecretRequired | secret |
EventsRequired | choice |
| Name | text |
| Status | choice |
| Field | Type |
|---|---|
| ID | text |
Create a User Webhook
ActionPersonal event feed delivered to a URL.
| Field | Type |
|---|---|
URLRequired | text |
SecretRequired | secret |
EventsRequired | choice |
| Name | text |
| Status | choice |
| Project IDs | array |
| Item | text |
| Styleguide IDs | array |
| Item | text |
| Field | Type |
|---|---|
| ID | text |
Create an Organization Webhook
ActionWebhook for events across an organization.
| Field | Type |
|---|---|
OrganizationRequired | choice |
URLRequired | text |
SecretRequired | secret |
EventsRequired | choice |
| Name | text |
| Status | choice |
| Project IDs | array |
| Item | text |
| Styleguide IDs | array |
| Item | text |
| Field | Type |
|---|---|
| ID | text |
Delete a Project Webhook
ActionHalts project event deliveries.
| Field | Type |
|---|---|
ProjectRequired | choice |
Webhook IDRequired | text |
| Field | Type |
|---|---|
| ID | text |
| Deleted | boolean |
Delete a Screen Annotation
ActionCleans a screen of a pinned annotation.
| Field | Type |
|---|---|
ProjectRequired | choice |
ScreenRequired | choice |
Annotation IDRequired | text |
| Field | Type |
|---|---|
| ID | text |
| Deleted | boolean |
Delete a Screen Comment
ActionClears one reply from a thread.
| Field | Type |
|---|---|
ProjectRequired | choice |
ScreenRequired | choice |
NoteRequired | choice |
Comment IDRequired | text |
| Field | Type |
|---|---|
| ID | text |
| Deleted | boolean |
Delete a Screen Note
ActionClears one review note from a design.
| Field | Type |
|---|---|
ProjectRequired | choice |
ScreenRequired | choice |
NoteRequired | choice |
| Field | Type |
|---|---|
| ID | text |
| Deleted | boolean |
Delete a Styleguide Webhook
ActionEnds calls to a styleguide URL.
| Field | Type |
|---|---|
StyleguideRequired | choice |
Webhook IDRequired | text |
| Field | Type |
|---|---|
| ID | text |
| Deleted | boolean |
Delete a User Webhook
ActionStops personal event deliveries.
| Field | Type |
|---|---|
Webhook IDRequired | text |
| Field | Type |
|---|---|
| ID | text |
| Deleted | boolean |
Delete an Organization Webhook
ActionStops event deliveries from an organization.
| Field | Type |
|---|---|
OrganizationRequired | choice |
Webhook IDRequired | text |
| Field | Type |
|---|---|
| ID | text |
| Deleted | boolean |
Invite a Project Member
ActionProject invitation by handle.
| Field | Type |
|---|---|
ProjectRequired | choice |
HandleRequired | text |
| Field | Type |
|---|---|
| ID | text |
Invite a Styleguide Member
ActionStyleguide invitation by email or username.
| Field | Type |
|---|---|
StyleguideRequired | choice |
HandleRequired | text |
| Field | Type |
|---|---|
| ID | text |
Invite an Organization Member
ActionOrganization invitation with a role.
| Field | Type |
|---|---|
OrganizationRequired | choice |
HandleRequired | text |
RoleRequired | choice |
RestrictedRequired | boolean |
| Tags | array |
| Item | text |
| Field | Type |
|---|---|
| User | object |
| ID | text |
| text | |
| Username | text |
| Emotar | text |
| Avatar | text |
| Last Seen | number |
| Role | text |
| Tags | array |
| Restricted | boolean |
| Invited | number |
Make an API Call
universalFree-form Zeplin REST API request.
| Field | Type |
|---|---|
URLRequired | text |
MethodRequired | choice |
| Headers | array |
| Header | object |
| Query string | array |
| Query string | object |
| Body | text |
| Field | Type |
|---|---|
| Body | text |
| Headers | object |
| Key | text |
| Value | text |
| Status code | number |
Remove a Project Member
ActionMember taken off a project roster.
| Field | Type |
|---|---|
ProjectRequired | choice |
Member IDRequired | text |
| Field | Type |
|---|---|
| ID | text |
| Deleted | boolean |
Remove a Styleguide Member
ActionEnds styleguide access for a user.
| Field | Type |
|---|---|
StyleguideRequired | choice |
Member IDRequired | text |
| Field | Type |
|---|---|
| ID | text |
| Deleted | boolean |
Remove an Organization Member
ActionEnds organization access of a person.
| Field | Type |
|---|---|
OrganizationRequired | choice |
MemberRequired | choice |
| Field | Type |
|---|---|
| ID | text |
| Deleted | boolean |
Update a Project
ActionEdits the name, description and status of a project.
| Field | Type |
|---|---|
ProjectRequired | choice |
| Name | text |
| Description | text |
| Organization | choice |
| Workflow Status | choice |
| Linked Styleguide | choice |
| Clear Fields | choice |
| Field | Type |
|---|---|
| ID | text |
| Updated | boolean |
Update a Project Color
ActionRecolors a palette entry.
| Field | Type |
|---|---|
ProjectRequired | choice |
Color IDRequired | text |
| Name | text |
| Red | number |
| Green | number |
| Blue | number |
| Alpha | number |
| Field | Type |
|---|---|
| ID | text |
| Updated | boolean |
Update a Project Component
ActionRewrites a component blurb.
| Field | Type |
|---|---|
ProjectRequired | choice |
Component IDRequired | text |
DescriptionRequired | text |
| Field | Type |
|---|---|
| ID | text |
| Updated | boolean |
Update a Project Spacing Token
ActionRenames or revalues a spacing token.
| Field | Type |
|---|---|
ProjectRequired | choice |
Spacing Token IDRequired | text |
| Name | text |
| Value | number |
| Field | Type |
|---|---|
| ID | text |
| Updated | boolean |
Update a Project Text Style
ActionRestyles a text preset of a project.
| Field | Type |
|---|---|
ProjectRequired | choice |
Text Style IDRequired | text |
| Name | text |
| Color | object |
RedRequired | number |
GreenRequired | number |
BlueRequired | number |
AlphaRequired | number |
| Source ID | text |
| Field | Type |
|---|---|
| ID | text |
| Updated | boolean |
Update a Project Webhook
ActionReconfigures a project hook.
| Field | Type |
|---|---|
ProjectRequired | choice |
Webhook IDRequired | text |
| URL | text |
| Name | text |
| Secret | secret |
| Status | choice |
| Events | choice |
| Field | Type |
|---|---|
| ID | text |
| Updated | boolean |
Update a Screen
ActionDescribes and tags a design.
| Field | Type |
|---|---|
ProjectRequired | choice |
ScreenRequired | choice |
| Description | text |
| Tags | array |
| Item | text |
| Clear Fields | choice |
| Field | Type |
|---|---|
| ID | text |
| Updated | boolean |
Update a Screen Annotation
ActionEdits or moves an annotation.
| Field | Type |
|---|---|
ProjectRequired | choice |
ScreenRequired | choice |
Annotation IDRequired | text |
| Content | text |
| Position | object |
XRequired | number |
YRequired | number |
| Type | text |
| Clear Fields | choice |
| Field | Type |
|---|---|
| ID | text |
| Updated | boolean |
Update a Screen Comment
ActionEdits the text of a note reply.
| Field | Type |
|---|---|
ProjectRequired | choice |
ScreenRequired | choice |
NoteRequired | choice |
Comment IDRequired | text |
ContentRequired | text |
| Field | Type |
|---|---|
| ID | text |
| Updated | boolean |
Update a Screen Note
ActionResolves or moves a note.
| Field | Type |
|---|---|
ProjectRequired | choice |
ScreenRequired | choice |
NoteRequired | choice |
| Status | choice |
| Position | object |
XRequired | number |
YRequired | number |
| X Start | number |
| Y Start | number |
| Color | choice |
| Field | Type |
|---|---|
| ID | text |
| Updated | boolean |
Update a Styleguide
ActionRenames or reparents a styleguide.
| Field | Type |
|---|---|
StyleguideRequired | choice |
| Name | text |
| Description | text |
| Parent Styleguide | choice |
| Clear Fields | choice |
| Field | Type |
|---|---|
| ID | text |
| Updated | boolean |
Update a Styleguide Color
ActionRecolors a shared swatch.
| Field | Type |
|---|---|
StyleguideRequired | choice |
Color IDRequired | text |
| Name | text |
| Red | number |
| Green | number |
| Blue | number |
| Alpha | number |
| Field | Type |
|---|---|
| ID | text |
| Updated | boolean |
Update a Styleguide Component
ActionRewrites a shared component blurb.
| Field | Type |
|---|---|
StyleguideRequired | choice |
Component IDRequired | text |
DescriptionRequired | text |
| Field | Type |
|---|---|
| ID | text |
| Updated | boolean |
Update a Styleguide Spacing Token
ActionRenames or revalues a shared spacing token.
| Field | Type |
|---|---|
StyleguideRequired | choice |
Spacing Token IDRequired | text |
| Name | text |
| Value | number |
| Field | Type |
|---|---|
| ID | text |
| Updated | boolean |
Update a Styleguide Text Style
ActionRestyles a shared text style.
| Field | Type |
|---|---|
StyleguideRequired | choice |
Text Style IDRequired | text |
| Name | text |
| Color | object |
RedRequired | number |
GreenRequired | number |
BlueRequired | number |
AlphaRequired | number |
| Source ID | text |
| Field | Type |
|---|---|
| ID | text |
| Updated | boolean |
Update a Styleguide Webhook
ActionRedirects a library hook.
| Field | Type |
|---|---|
StyleguideRequired | choice |
Webhook IDRequired | text |
| URL | text |
| Name | text |
| Secret | secret |
| Status | choice |
| Events | choice |
| Field | Type |
|---|---|
| ID | text |
| Updated | boolean |
Update a User Notification
ActionFlips read state of a notification.
| Field | Type |
|---|---|
Notification IDRequired | text |
ReadRequired | boolean |
| Field | Type |
|---|---|
| ID | text |
| Updated | boolean |
Update a User Webhook
ActionReconfigures a personal hook.
| Field | Type |
|---|---|
Webhook IDRequired | text |
| URL | text |
| Name | text |
| Secret | secret |
| Status | choice |
| Project IDs | array |
| Item | text |
| Styleguide IDs | array |
| Item | text |
| Events | choice |
| Field | Type |
|---|---|
| ID | text |
| Updated | boolean |
Update an Organization Member
ActionRole and tags of a teammate.
| Field | Type |
|---|---|
OrganizationRequired | choice |
MemberRequired | choice |
| Tags | array |
| Item | text |
| Role | choice |
| Restricted | choice |
| Clear Fields | choice |
| Field | Type |
|---|---|
| ID | text |
| Updated | boolean |
Templates
Look for Zeplin templates in the WEXTL template library.
Browse templates →Other productivity integrations on WEXTL
Form.io[2]Enterprise form and data management platform for building forms, collecting submissions, and managing projects.
GrainMeeting recordings, with transcripts, uploads, and hooks.
FeatheryForms, document extraction and e-signature: manage submissions, run extractions and fill documents.
Frame.io V4Creative review platform for teams and their media.
Agiled (Public API)Manage clients, deals, projects, invoices and bookings in Agiled.
References
- WEXTL® Zeplin Source Code connector implementation.
- Our users use cases and automations.
- Official API Documentation for Zeplin.
- WEXTL® visual workflow builder data.
Last updated: Nov 14, 2026 14:55
How we write our apps documentation
How we compile these docs: sources, the role of AI, and how we verify.






























