Skip to docs navigation

Zeplin integration guide

Verified

How 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].

Open Zeplin on WEXTL →
  • Zeplin
  • WEXTL
  • Form.io
  • Grain
  • Feathery
  • Frame.io V4
  • Agiled (Public API)
  • ChMeetings
  • Egnyte
  • Grist
  • Docupilot
  • Outline
  • BoldSign
  • codeREADr
  • DocuSeal
  • CraftMyPDF
  • Goody
  • Carbone
  • Dailybot
  • Mem
  • KoBoToolbox
  • Paperless-ngx
  • Mural
  • ONLYOFFICE Docs
  • Adobe Acrobat Sign
  • Interact
  • Nextcloud
  • Formstack Documents
  • eSignatures.com
  • Beeminder
  • Aboard Sign
  • DocuSign
Credential type option 1

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]

Credential type option 2

Zeplin - OAuth

You’ll be redirected to sign in and approve access. Your password is never shared with WEXTL.

  • Client IDtextRequired

    In Zeplin open your Profile, then the Developer tab, create an application and copy its Client ID. Add the redirect URL shown on this form to the application.[1]

  • Client SecretpasswordRequired

    The Client Secret of the same Zeplin application.[1]

  1. 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.
  2. Optional: In the Credential name field, enter a name for the credential.
  3. Enter the authentication credentials you copied from your Zeplin account, or follow the on-screen instructions to create the credential.
  4. If prompted, authenticate your account and confirm access.
  5. If you want to make changes to your credential in the future, follow the steps in Manage credentials →

Watch Events (Instant)

TriggerInstant trigger for Zeplin events.
Output fields[3]
FieldType
Eventtext
Actiontext
Timestampnumber
Resourceobject
IDtext
Typetext
Datatext
Contexttext

Get a Project

SearchPlatform and description of a project.
Input fields[3]
FieldType
ProjectRequired
choice
Output fields[3]
FieldType
IDtext
Nametext
Descriptiontext
Platformtext
Thumbnailtext
Statustext
Scene URLtext
Creatednumber
Updatednumber
Number Of Membersnumber

6other output fields

Get a Project Component

SearchComponent data, with optional version.
Input fields[3]
FieldType
ProjectRequired
choice
Component IDRequired
text
Include Latest Versionboolean
Include Linked Styleguidesboolean
Output fields[3]
FieldType
IDtext
Nametext
Descriptiontext
Imageobject
Widthnumber
Heightnumber
Original URLtext
Thumbnailsobject
Creatednumber
Updatednumber
Sectionobject
IDtext
Groupobject
Sourceobject
Projectobject
Variant Propertiesarray
IDtext
Nametext
Valuetext

Get a Project Flow Board

SearchSize summary of a flow board.
Input fields[3]
FieldType
ProjectRequired
choice
Flow Board IDRequired
text
Output fields[3]
FieldType
IDtext
Nametext
Number Of Connectorsnumber
Number Of Nodesnumber
Number Of Groupsnumber

Get a Project Flow Board Connector

SearchLink between two flow board nodes.
Input fields[3]
FieldType
ProjectRequired
choice
Flow Board IDRequired
text
Connector IDRequired
text
Output fields[3]
FieldType
IDtext
Typetext
Startobject
Nodeobject
Node Positionobject
Endobject
Nodeobject
Node Positionobject
Labelobject

Get a Project Flow Board Node

SearchWhere one node sits on a user-flow diagram.
Input fields[3]
FieldType
ProjectRequired
choice
Flow Board IDRequired
text
Node IDRequired
text
Output fields[3]
FieldType
IDtext
Typetext
Screenobject
IDtext
Positionobject
Xnumber
Ynumber

Get a Project Webhook

SearchWho made a project hook and when.
Input fields[3]
FieldType
ProjectRequired
choice
Webhook IDRequired
text
Output fields[3]
FieldType
IDtext
Nametext
Statustext
Creatednumber
Created Byobject
IDtext
Emailtext
Updatednumber
Updated Byobject
IDtext
Emailtext
URLtext
URL Healthtext
Eventsarray

Get a Screen

SearchName, tags and image of a screen.
Input fields[3]
FieldType
ProjectRequired
choice
ScreenRequired
choice
Output fields[3]
FieldType
IDtext
Nametext
Descriptiontext
Tagsarray
Imageobject
Widthnumber
Heightnumber
Original URLtext
Thumbnailsobject
Creatednumber
Updatednumber
Number Of Notesnumber
Number Of Versionsnumber
Number Of Annotationsnumber

2other output fields

Get a Screen Annotation

SearchText and position of an annotation.
Input fields[3]
FieldType
ProjectRequired
choice
ScreenRequired
choice
Annotation IDRequired
text
Output fields[3]
FieldType
IDtext
Contenttext
Typeobject
IDtext
Nametext
Colorobject
Positionobject
Xnumber
Ynumber
Creatorobject
IDtext
Emailtext
Usernametext
Emotartext
Avatartext
Last Seennumber
Updated Byobject
IDtext
Emailtext
Usernametext
Emotartext
Avatartext
Last Seennumber
Updatednumber
Creatednumber

Get a Screen Note

SearchStatus and position of a note.
Input fields[3]
FieldType
ProjectRequired
choice
ScreenRequired
choice
NoteRequired
choice
Output fields[3]
FieldType
IDtext
Creatednumber
Ordernumber
Statustext
Positionobject
Xnumber
Ynumber
X Startnumber
Y Startnumber
Colorobject
Nametext
Rnumber
Gnumber
Bnumber
Anumber
Creatorobject
IDtext
Emailtext
Usernametext
Emotartext
Avatartext
Last Seennumber
Commentsarray
IDtext
Authorobject
Contenttext
Updatednumber
Reactionsarray
Screen Version IDtext

Get a Screen Section

SearchName and parent of a screen section.
Input fields[3]
FieldType
ProjectRequired
choice
Section IDRequired
text
Output fields[3]
FieldType
IDtext
Creatednumber
Nametext
Parentobject
IDtext

Get a Screen Variant

SearchGrouped screen variants under one name.
Input fields[3]
FieldType
ProjectRequired
choice
Variant IDRequired
text
Output fields[3]
FieldType
IDtext
Nametext
Variantsarray
Screen IDtext
Valuetext

Get a Screen Version

SearchHistoric image of a screen.
Input fields[3]
FieldType
ProjectRequired
choice
ScreenRequired
choice
Version IDRequired
text
Output fields[3]
FieldType
IDtext
Creatorobject
IDtext
Emailtext
Usernametext
Emotartext
Avatartext
Last Seennumber
Commitobject
Messagetext
Authorobject
Colorobject
Image URLtext
Thumbnailsobject
Smalltext
Mediumtext
Largetext
Widthnumber
Heightnumber
Density Scalenumber
Sourcetext
Source File URLtext

4other output fields

Get a Styleguide

SearchPlatform, status and description of a styleguide.
Input fields[3]
FieldType
StyleguideRequired
choice
Linked Projecttext
Linked Styleguidetext
Output fields[3]
FieldType
IDtext
Nametext
Descriptiontext
Platformtext
Thumbnailtext
Statustext
Creatednumber
Updatednumber
Number Of Membersnumber
Number Of Componentsnumber

4other output fields

Get a Styleguide Component

SearchComponent data with optional newest render.
Input fields[3]
FieldType
StyleguideRequired
choice
Component IDRequired
text
Linked Projecttext
Linked Styleguidetext
Include Latest Versionboolean
Include Linked Styleguidesboolean
Output fields[3]
FieldType
IDtext
Nametext
Descriptiontext
Imageobject
Widthnumber
Heightnumber
Original URLtext
Thumbnailsobject
Creatednumber
Updatednumber
Sectionobject
IDtext
Groupobject
Sourceobject
Projectobject
Variant Propertiesarray
IDtext
Nametext
Valuetext

Get a Styleguide Webhook

SearchCreator and status of a styleguide hook.
Input fields[3]
FieldType
StyleguideRequired
choice
Webhook IDRequired
text
Output fields[3]
FieldType
IDtext
Nametext
Statustext
Creatednumber
Created Byobject
IDtext
Emailtext
Updatednumber
Updated Byobject
IDtext
Emailtext
URLtext
URL Healthtext
Eventsarray

Get a User Notification

SearchRead state of a notification.
Input fields[3]
FieldType
Notification IDRequired
text
Output fields[3]
FieldType
IDtext
Timestampnumber
Typetext
Actiontext
Is Readboolean
Resourceobject
IDtext
Typetext
Extraobject
Contextobject
Projectobject
Actorobject
Userobject

Get a User Webhook

SearchSettings of a personal hook.
Input fields[3]
FieldType
Webhook IDRequired
text
Output fields[3]
FieldType
IDtext
Nametext
Statustext
Creatednumber
Created Byobject
IDtext
Emailtext
Updatednumber
Updated Byobject
IDtext
Emailtext
URLtext
URL Healthtext
Eventsarray

2other output fields

Get an Organization

SearchOrganization name and member list.
Input fields[3]
FieldType
OrganizationRequired
choice
Output fields[3]
FieldType
IDtext
Nametext
Membersarray
Userobject
Roletext
Tagsarray
Restrictedboolean
Invitednumber

Get an Organization Webhook

SearchWho made an organization hook and when.
Input fields[3]
FieldType
OrganizationRequired
choice
Webhook IDRequired
text
Output fields[3]
FieldType
IDtext
Nametext
Statustext
Creatednumber
Created Byobject
IDtext
Emailtext
Updatednumber
Updated Byobject
IDtext
Emailtext
URLtext
URL Healthtext
Eventsarray

2other output fields

Get Organization Billing

SearchSeat usage of an organization.
Input fields[3]
FieldType
OrganizationRequired
choice
Output fields[3]
FieldType
Total Seat Countnumber
Used Seat Countnumber

Get Project Design Tokens

SearchColors, spacing and type tokens for code.
Input fields[3]
FieldType
ProjectRequired
choice
Include Linked Styleguidesboolean
Token Name Casechoice
Output fields[3]
FieldType
Colorsobject
Yellowobject
Light-yellowobject
Spacingobject
Xs-spacingobject
Text Stylesobject
Header-h1object
Header-h2object

Get Styleguide Design Tokens

SearchShared tokens ready for code generation.
Input fields[3]
FieldType
StyleguideRequired
choice
Include Linked Styleguidesboolean
Token Name Casechoice
Output fields[3]
FieldType
Colorsobject
Yellowobject
Light-yellowobject
Spacingobject
Xs-spacingobject
Text Stylesobject
Header-h1object
Header-h2object

Get the Current User

SearchIdentity of the credential owner.
Output fields[3]
FieldType
IDtext
Emailtext
Usernametext
Emotartext
Avatartext
Last Seennumber

Get the Latest Screen Version

SearchMost recent image upload of a screen.
Input fields[3]
FieldType
ProjectRequired
choice
ScreenRequired
choice
Output fields[3]
FieldType
IDtext
Creatorobject
IDtext
Emailtext
Usernametext
Emotartext
Avatartext
Last Seennumber
Commitobject
Messagetext
Authorobject
Colorobject
Image URLtext
Thumbnailsobject
Smalltext
Mediumtext
Largetext
Widthnumber
Heightnumber
Density Scalenumber
Sourcetext
Source File URLtext

4other output fields

Get the Latest Version of a Project Component

SearchCurrent image of a project component.
Input fields[3]
FieldType
ProjectRequired
choice
Component IDRequired
text
Include Linked Styleguidesboolean
Output fields[3]
FieldType
IDtext
Creatednumber
Creatorobject
IDtext
Emailtext
Usernametext
Emotartext
Avatartext
Last Seennumber
Image URLtext
Thumbnailsobject
Smalltext
Mediumtext
Largetext
Widthnumber
Heightnumber
Density Scalenumber
Sourcetext
Source File URLtext

4other output fields

Get the Latest Version of a Styleguide Component

SearchCurrent render of a shared component.
Input fields[3]
FieldType
StyleguideRequired
choice
Component IDRequired
text
Linked Projecttext
Linked Styleguidetext
Include Linked Styleguidesboolean
Output fields[3]
FieldType
IDtext
Creatednumber
Creatorobject
IDtext
Emailtext
Usernametext
Emotartext
Avatartext
Last Seennumber
Image URLtext
Thumbnailsobject
Smalltext
Mediumtext
Largetext
Widthnumber
Heightnumber
Density Scalenumber
Sourcetext
Source File URLtext

4other output fields

List Organization Aliens

SearchAlien-role accounts in an organization.
Input fields[3]
FieldType
OrganizationRequired
choice
Output fields[3]
FieldType
IDtext
Emailtext
Usernametext
Emotartext
Avatartext
Last Seennumber

List Organization Member Projects

SearchProjects a teammate was added to.
Input fields[3]
FieldType
OrganizationRequired
choice
MemberRequired
choice
LimitRequired
number
Output fields[3]
FieldType
IDtext
Nametext
Descriptiontext
Platformtext
Thumbnailtext
Statustext
Scene URLtext
Creatednumber
Updatednumber
Number Of Membersnumber

9other output fields

List Organization Member Styleguides

SearchStyleguides a teammate has joined.
Input fields[3]
FieldType
OrganizationRequired
choice
MemberRequired
choice
LimitRequired
number
Output fields[3]
FieldType
IDtext
Nametext
Descriptiontext
Platformtext
Thumbnailtext
Statustext
Creatednumber
Updatednumber
Number Of Membersnumber
Number Of Componentsnumber

4other output fields

List Organization Members

SearchRoster with roles and tags.
Input fields[3]
FieldType
OrganizationRequired
choice
LimitRequired
number
Handlearray
Itemtext
Output fields[3]
FieldType
Userobject
IDtext
Emailtext
Usernametext
Emotartext
Avatartext
Last Seennumber
Roletext
Tagsarray
Restrictedboolean
Invitednumber

List Organization Projects

SearchEverything an organization is designing.
Input fields[3]
FieldType
OrganizationRequired
choice
LimitRequired
number
Output fields[3]
FieldType
IDtext
Nametext
Descriptiontext
Platformtext
Thumbnailtext
Statustext
Creatednumber
Updatednumber
Organizationobject
IDtext
Nametext
Logotext
Workflow Statusobject
IDtext
Nametext
Colorobject

8other output fields

List Organization Styleguides

SearchStyleguides owned by one organization account.
Input fields[3]
FieldType
OrganizationRequired
choice
LimitRequired
number
Output fields[3]
FieldType
IDtext
Nametext
Descriptiontext
Platformtext
Thumbnailtext
Statustext
Creatednumber
Updatednumber
Organizationobject
IDtext
Nametext
Logotext
Number Of Membersnumber

6other output fields

List Organization Webhooks

SearchHook deliveries and their URL health.
Input fields[3]
FieldType
OrganizationRequired
choice
LimitRequired
number
Statuschoice
URL Healthchoice
Output fields[3]
FieldType
IDtext
Nametext
Statustext
Creatednumber
Created Byobject
IDtext
Emailtext
Updatednumber
Updated Byobject
IDtext
Emailtext
URLtext
URL Healthtext
Eventsarray

2other output fields

List Organization Workflow Statuses

SearchStatus labels used in project workflows.
Input fields[3]
FieldType
OrganizationRequired
choice
Output fields[3]
FieldType
IDtext
Nametext
Colorobject
Nametext
Rnumber
Gnumber
Bnumber
Anumber

List Organizations

SearchOrganizations your account is part of.
Input fields[3]
FieldType
Rolechoice
Output fields[3]
FieldType
IDtext
Nametext
Logotext

List Project Colors

SearchSwatches saved in a project.
Input fields[3]
FieldType
ProjectRequired
choice
LimitRequired
number
Include Linked Styleguidesboolean
Output fields[3]
FieldType
IDtext
Source IDtext
Creatednumber
Nametext
Rnumber
Gnumber
Bnumber
Anumber
Variable Infoobject
Source IDtext
Collection Source IDtext
Sourceobject
Projectobject

List Project Component Sections

SearchComponent sections grouped under project pages.
Input fields[3]
FieldType
ProjectRequired
choice
LimitRequired
number
Page IDtext
Output fields[3]
FieldType
IDtext
Creatednumber
Nametext
Groupsarray
IDtext
Creatednumber
Nametext
Variantobject
Propertiesarray
Source IDtext

List Project Components

SearchReusable pieces inside a project.
Input fields[3]
FieldType
ProjectRequired
choice
LimitRequired
number
Section IDtext
Sortchoice
Include Latest Versionboolean
Include Linked Styleguidesboolean
Output fields[3]
FieldType
IDtext
Nametext
Descriptiontext
Imageobject
Widthnumber
Heightnumber
Original URLtext
Thumbnailsobject
Creatednumber
Updatednumber
Sectionobject
IDtext
Groupobject
Sourceobject
Projectobject
Variant Propertiesarray
IDtext
Nametext
Valuetext

List Project Connected Components

SearchDesign pieces mapped to source code.
Input fields[3]
FieldType
ProjectRequired
choice
LimitRequired
number
Include Linked Styleguidesboolean
Output fields[3]
FieldType
Componentsarray
IDtext
Nametext
Descriptiontext
Codeobject
Snippettext
Languagetext
Linksarray
Typetext
URLtext
Nametext

List Project Flow Board Connectors

SearchConnectors between flow board nodes.
Input fields[3]
FieldType
ProjectRequired
choice
Flow Board IDRequired
text
LimitRequired
number
Starting Node IDtext
Ending Node IDtext
Output fields[3]
FieldType
IDtext
Typetext
Startobject
Nodeobject
Node Positionobject
Endobject
Nodeobject
Node Positionobject
Labelobject

List Project Flow Board Groups

SearchColored clusters on a user flow.
Input fields[3]
FieldType
ProjectRequired
choice
Flow Board IDRequired
text
Output fields[3]
FieldType
IDtext
Creatednumber
Nametext
Colorobject
Source IDtext
Rnumber
Gnumber
Bnumber
Anumber

List Project Flow Board Nodes

SearchNodes laid out on a user flow.
Input fields[3]
FieldType
ProjectRequired
choice
Flow Board IDRequired
text
LimitRequired
number
Group IDtext
Output fields[3]
FieldType
IDtext
Typetext
Screenobject
IDtext
Positionobject
Xnumber
Ynumber

List Project Flow Boards

SearchUser-flow diagrams and their size.
Input fields[3]
FieldType
ProjectRequired
choice
Output fields[3]
FieldType
IDtext
Nametext
Number Of Connectorsnumber
Number Of Nodesnumber
Number Of Groupsnumber

List Project Members

SearchCollaborators and roles on a project.
Input fields[3]
FieldType
ProjectRequired
choice
LimitRequired
number
Output fields[3]
FieldType
Userobject
IDtext
Emailtext
Usernametext
Emotartext
Avatartext
Last Seennumber
Roletext

List Project Pages

SearchPage names and types inside a project.
Input fields[3]
FieldType
ProjectRequired
choice
LimitRequired
number
Output fields[3]
FieldType
IDtext
Creatednumber
Nametext
Typetext
Descriptiontext
Component Sectionsarray

List Project Screens

SearchAll designs uploaded to a project.
Input fields[3]
FieldType
ProjectRequired
choice
LimitRequired
number
Section IDchoice
Sortchoice
Output fields[3]
FieldType
IDtext
Nametext
Descriptiontext
Tagsarray
Imageobject
Widthnumber
Heightnumber
Original URLtext
Thumbnailsobject
Creatednumber
Updatednumber
Number Of Notesnumber
Number Of Versionsnumber
Number Of Annotationsnumber

2other output fields

List Project Spacing Sections

SearchGroupings for spacing tokens.
Input fields[3]
FieldType
ProjectRequired
choice
LimitRequired
number
Output fields[3]
FieldType
IDtext

List Project Spacing Tokens

SearchSpacing scale entries by ID.
Input fields[3]
FieldType
ProjectRequired
choice
LimitRequired
number
Include Linked Styleguidesboolean
Output fields[3]
FieldType
IDtext

List Project Text Styles

SearchFonts and type presets in a project.
Input fields[3]
FieldType
ProjectRequired
choice
LimitRequired
number
Include Linked Styleguidesboolean
Output fields[3]
FieldType
IDtext
Nametext
Creatednumber
Postscript Nametext
Font Familytext
Font Sizenumber
Font Weightnumber
Font Styletext
Line Heightnumber
Font Stretchnumber

3other output fields

List Project Variable Collections

SearchDesign variable sets stored in a project.
Input fields[3]
FieldType
ProjectRequired
choice
LimitRequired
number
Include Linked Styleguidesboolean
Output fields[3]
FieldType
IDtext
Creatednumber
Nametext
Source IDtext
Modesobject
Summarytext
Valueobject
Groupsobject
Summarytext
Valueobject

List Project Webhooks

SearchEvent hooks watching a project.
Input fields[3]
FieldType
ProjectRequired
choice
LimitRequired
number
Statuschoice
URL Healthchoice
Output fields[3]
FieldType
IDtext
Nametext
Statustext
Creatednumber
Created Byobject
IDtext
Emailtext
Updatednumber
Updated Byobject
IDtext
Emailtext
URLtext
URL Healthtext
Eventsarray

List Projects

SearchYour projects, scoped to a workspace.
Input fields[3]
FieldType
LimitRequired
number
Workspacetext
Statuschoice
Output fields[3]
FieldType
IDtext
Nametext
Descriptiontext
Platformtext
Thumbnailtext
Statustext
Scene URLtext
Creatednumber
Updatednumber
Number Of Membersnumber

9other output fields

List Screen Annotation Note Types

SearchAnnotation categories of a project.
Input fields[3]
FieldType
ProjectRequired
choice
Output fields[3]
FieldType
IDtext
Nametext
Colorobject
Nametext
Rnumber
Gnumber
Bnumber
Anumber

List Screen Annotations

SearchPinned commentary on a design.
Input fields[3]
FieldType
ProjectRequired
choice
ScreenRequired
choice
LimitRequired
number
Output fields[3]
FieldType
IDtext
Contenttext
Typeobject
IDtext
Nametext
Colorobject
Positionobject
Xnumber
Ynumber
Creatorobject
IDtext
Emailtext
Usernametext
Emotartext
Avatartext
Last Seennumber
Updated Byobject
IDtext
Emailtext
Usernametext
Emotartext
Avatartext
Last Seennumber
Updatednumber
Creatednumber

List Screen Components

SearchBuilding blocks used in one design.
Input fields[3]
FieldType
ProjectRequired
choice
ScreenRequired
choice
LimitRequired
number
Include Latest Versionboolean
Include Linked Styleguidesboolean
Output fields[3]
FieldType
IDtext
Nametext
Descriptiontext
Imageobject
Widthnumber
Heightnumber
Original URLtext
Thumbnailsobject
Creatednumber
Updatednumber
Sectionobject
IDtext
Groupobject
Sourceobject
Projectobject
Variant Propertiesarray
IDtext
Nametext
Valuetext

List Screen Notes

SearchReview feedback pinned to one screen.
Input fields[3]
FieldType
ProjectRequired
choice
ScreenRequired
choice
LimitRequired
number
Output fields[3]
FieldType
IDtext
Creatednumber
Ordernumber
Statustext
Positionobject
Xnumber
Ynumber
X Startnumber
Y Startnumber
Colorobject
Nametext
Rnumber
Gnumber
Bnumber
Anumber
Creatorobject
IDtext
Emailtext
Usernametext
Emotartext
Avatartext
Last Seennumber
Commentsarray
IDtext
Authorobject
Contenttext
Updatednumber
Reactionsarray
Screen Version IDtext

List Screen Sections

SearchScreen folders and their nesting.
Input fields[3]
FieldType
ProjectRequired
choice
LimitRequired
number
Output fields[3]
FieldType
IDtext
Creatednumber
Nametext
Parentobject
IDtext

List Screen Variants

SearchAlternative designs of a screen.
Input fields[3]
FieldType
ProjectRequired
choice
LimitRequired
number
Output fields[3]
FieldType
IDtext
Nametext
Variantsarray
Screen IDtext
Valuetext

List Screen Versions

SearchUpload history of a screen.
Input fields[3]
FieldType
ProjectRequired
choice
ScreenRequired
choice
LimitRequired
number
Output fields[3]
FieldType
IDtext
Creatorobject
IDtext
Emailtext
Usernametext
Emotartext
Avatartext
Last Seennumber
Commitobject
Messagetext
Authorobject
Colorobject
Image URLtext
Thumbnailsobject
Smalltext
Mediumtext
Largetext
Widthnumber
Heightnumber
Density Scalenumber
Sourcetext
Source File URLtext

2other output fields

List Styleguide Colors

SearchSwatches in a shared library.
Input fields[3]
FieldType
StyleguideRequired
choice
LimitRequired
number
Linked Projecttext
Linked Styleguidetext
Include Linked Styleguidesboolean
Output fields[3]
FieldType
IDtext
Source IDtext
Creatednumber
Nametext
Rnumber
Gnumber
Bnumber
Anumber
Variable Infoobject
Source IDtext
Collection Source IDtext
Sourceobject
Projectobject

List Styleguide Component Sections

SearchFolders of shared components.
Input fields[3]
FieldType
StyleguideRequired
choice
LimitRequired
number
Page IDtext
Linked Projecttext
Linked Styleguidetext
Output fields[3]
FieldType
IDtext

List Styleguide Components

SearchReusable parts of a styleguide.
Input fields[3]
FieldType
StyleguideRequired
choice
LimitRequired
number
Section IDtext
Sortchoice
Linked Projecttext
Linked Styleguidetext
Include Linked Styleguidesboolean
Include Latest Versionboolean
Output fields[3]
FieldType
IDtext
Nametext
Descriptiontext
Imageobject
Widthnumber
Heightnumber
Original URLtext
Thumbnailsobject
Creatednumber
Updatednumber
Sectionobject
IDtext
Groupobject
Sourceobject
Projectobject
Variant Propertiesarray
IDtext
Nametext
Valuetext

List Styleguide Connected Components

SearchShared pieces mapped to source code.
Input fields[3]
FieldType
StyleguideRequired
choice
LimitRequired
number
Linked Projecttext
Linked Styleguidetext
Include Linked Styleguidesboolean
Output fields[3]
FieldType
Componentsarray
IDtext
Nametext
Descriptiontext
Codeobject
Snippettext
Languagetext
Linksarray
Typetext
URLtext
Nametext

List Styleguide Linked Projects

SearchProjects that pull from a shared styleguide.
Input fields[3]
FieldType
StyleguideRequired
choice
LimitRequired
number
Output fields[3]
FieldType
IDtext
Nametext
Descriptiontext
Platformtext
Thumbnailtext
Statustext
Scene URLtext
Creatednumber
Updatednumber
Number Of Membersnumber

6other output fields

List Styleguide Members

SearchCollaborators of a styleguide and their roles.
Input fields[3]
FieldType
StyleguideRequired
choice
LimitRequired
number
Linked Projecttext
Linked Styleguidetext
Output fields[3]
FieldType
Userobject
IDtext
Emailtext
Usernametext
Emotartext
Avatartext
Last Seennumber
Roletext

List Styleguide Pages

SearchPages, with name and type, of a styleguide.
Input fields[3]
FieldType
StyleguideRequired
choice
LimitRequired
number
Output fields[3]
FieldType
IDtext
Creatednumber
Nametext
Typetext
Descriptiontext
Component Sectionsarray

List Styleguide Spacing Sections

SearchSpacing token sections by ID.
Input fields[3]
FieldType
StyleguideRequired
choice
LimitRequired
number
Linked Projecttext
Linked Styleguidetext
Output fields[3]
FieldType
IDtext

List Styleguide Spacing Tokens

SearchSpacing token IDs saved in a styleguide.
Input fields[3]
FieldType
StyleguideRequired
choice
LimitRequired
number
Linked Projecttext
Linked Styleguidetext
Include Linked Styleguidesboolean
Output fields[3]
FieldType
IDtext

List Styleguide Text Styles

SearchTypography presets saved in a styleguide.
Input fields[3]
FieldType
StyleguideRequired
choice
LimitRequired
number
Linked Projecttext
Linked Styleguidetext
Include Linked Styleguidesboolean
Output fields[3]
FieldType
IDtext
Nametext
Creatednumber
Postscript Nametext
Font Familytext
Font Sizenumber
Font Weightnumber
Font Styletext
Line Heightnumber
Font Stretchnumber

3other output fields

List Styleguide Variable Collections

SearchDesign variable sets of a styleguide.
Input fields[3]
FieldType
StyleguideRequired
choice
LimitRequired
number
Include Linked Styleguidesboolean
Output fields[3]
FieldType
IDtext
Creatednumber
Nametext
Source IDtext
Modesobject
Summarytext
Valueobject
Groupsobject
Summarytext
Valueobject

List Styleguide Webhooks

SearchWebhooks delivering styleguide events.
Input fields[3]
FieldType
StyleguideRequired
choice
LimitRequired
number
Statuschoice
URL Healthchoice
Output fields[3]
FieldType
IDtext
Nametext
Statustext
Creatednumber
Created Byobject
IDtext
Emailtext
Updatednumber
Updated Byobject
IDtext
Emailtext
URLtext
URL Healthtext
Eventsarray

List Styleguides

SearchEvery styleguide reachable by your account.
Input fields[3]
FieldType
LimitRequired
number
Workspacetext
Statuschoice
Linked Projecttext
Linked Styleguidetext
Output fields[3]
FieldType
IDtext
Nametext
Descriptiontext
Platformtext
Thumbnailtext
Statustext
Creatednumber
Updatednumber
Number Of Membersnumber
Number Of Componentsnumber

4other output fields

List User Notifications

SearchYour inbox of Zeplin alerts.
Input fields[3]
FieldType
LimitRequired
number
Readchoice
Typechoice
Output fields[3]
FieldType
IDtext
Timestampnumber
Typetext
Actiontext
Is Readboolean
Resourceobject
IDtext
Typetext
Extraobject
Contextobject
Projectobject
Actorobject
Userobject

List User Projects

SearchWork you take part in.
Input fields[3]
FieldType
LimitRequired
number
Statuschoice
Output fields[3]
FieldType
IDtext
Nametext
Descriptiontext
Platformtext
Thumbnailtext
Statustext
Scene URLtext
Creatednumber
Updatednumber
Number Of Membersnumber

6other output fields

List User Styleguides

SearchStyleguides you take part in.
Input fields[3]
FieldType
LimitRequired
number
Statuschoice
Output fields[3]
FieldType
IDtext
Nametext
Descriptiontext
Platformtext
Thumbnailtext
Statustext
Creatednumber
Updatednumber
Number Of Membersnumber
Number Of Componentsnumber

4other output fields

List User Webhooks

SearchPersonal event hooks you made.
Input fields[3]
FieldType
LimitRequired
number
Statuschoice
URL Healthchoice
Output fields[3]
FieldType
IDtext
Nametext
Statustext
Creatednumber
Created Byobject
IDtext
Emailtext
Updatednumber
Updated Byobject
IDtext
Emailtext
URLtext
URL Healthtext
Eventsarray

2other output fields

Create a Project Color

ActionPalette entry with RGBA values.
Input fields[3]
FieldType
ProjectRequired
choice
NameRequired
text
RedRequired
number
GreenRequired
number
BlueRequired
number
AlphaRequired
number
Source IDtext
Output fields[3]
FieldType
IDtext

Create a Project Webhook

ActionEvent delivery to a URL.
Input fields[3]
FieldType
ProjectRequired
choice
URLRequired
text
SecretRequired
secret
EventsRequired
choice
Nametext
Statuschoice
Output fields[3]
FieldType
IDtext

Create a Screen

ActionScreen from an uploaded image.
Input fields[3]
FieldType
ProjectRequired
choice
NameRequired
text
ImageRequired
text
Descriptiontext
Commit Messagetext
Commit Colorchoice
Tagsarray
Itemtext
Screen Sectionchoice
Output fields[3]
FieldType
IDtext

Create a Screen Annotation

ActionAnnotation pinned to a screen position.
Input fields[3]
FieldType
ProjectRequired
choice
ScreenRequired
choice
ContentRequired
text
PositionRequired
object
XRequired
number
YRequired
number
Typetext
Output fields[3]
FieldType
IDtext

Create a Screen Comment

ActionReply added to a screen note.
Input fields[3]
FieldType
ProjectRequired
choice
ScreenRequired
choice
NoteRequired
choice
ContentRequired
text
Output fields[3]
FieldType
IDtext

Create a Screen Note

ActionReview note placed over a design.
Input fields[3]
FieldType
ProjectRequired
choice
ScreenRequired
choice
ContentRequired
text
PositionRequired
object
XRequired
number
YRequired
number
X Startnumber
Y Startnumber
ColorRequired
choice
Output fields[3]
FieldType
IDtext

Create a Screen Version

ActionNewer image for an existing screen.
Input fields[3]
FieldType
ProjectRequired
choice
ScreenRequired
choice
ImageRequired
text
Commit Messagetext
Commit Colorchoice
Output fields[3]
FieldType
IDtext

Create a Styleguide Color

ActionShared swatch for a styleguide.
Input fields[3]
FieldType
StyleguideRequired
choice
NameRequired
text
RedRequired
number
GreenRequired
number
BlueRequired
number
AlphaRequired
number
Source IDtext
Output fields[3]
FieldType
IDtext

Create a Styleguide Webhook

ActionEvent feed for a styleguide.
Input fields[3]
FieldType
StyleguideRequired
choice
URLRequired
text
SecretRequired
secret
EventsRequired
choice
Nametext
Statuschoice
Output fields[3]
FieldType
IDtext

Create a User Webhook

ActionPersonal event feed delivered to a URL.
Input fields[3]
FieldType
URLRequired
text
SecretRequired
secret
EventsRequired
choice
Nametext
Statuschoice
Project IDsarray
Itemtext
Styleguide IDsarray
Itemtext
Output fields[3]
FieldType
IDtext

Create an Organization Webhook

ActionWebhook for events across an organization.
Input fields[3]
FieldType
OrganizationRequired
choice
URLRequired
text
SecretRequired
secret
EventsRequired
choice
Nametext
Statuschoice
Project IDsarray
Itemtext
Styleguide IDsarray
Itemtext
Output fields[3]
FieldType
IDtext

Delete a Project Webhook

ActionHalts project event deliveries.
Input fields[3]
FieldType
ProjectRequired
choice
Webhook IDRequired
text
Output fields[3]
FieldType
IDtext
Deletedboolean

Delete a Screen Annotation

ActionCleans a screen of a pinned annotation.
Input fields[3]
FieldType
ProjectRequired
choice
ScreenRequired
choice
Annotation IDRequired
text
Output fields[3]
FieldType
IDtext
Deletedboolean

Delete a Screen Comment

ActionClears one reply from a thread.
Input fields[3]
FieldType
ProjectRequired
choice
ScreenRequired
choice
NoteRequired
choice
Comment IDRequired
text
Output fields[3]
FieldType
IDtext
Deletedboolean

Delete a Screen Note

ActionClears one review note from a design.
Input fields[3]
FieldType
ProjectRequired
choice
ScreenRequired
choice
NoteRequired
choice
Output fields[3]
FieldType
IDtext
Deletedboolean

Delete a Styleguide Webhook

ActionEnds calls to a styleguide URL.
Input fields[3]
FieldType
StyleguideRequired
choice
Webhook IDRequired
text
Output fields[3]
FieldType
IDtext
Deletedboolean

Delete a User Webhook

ActionStops personal event deliveries.
Input fields[3]
FieldType
Webhook IDRequired
text
Output fields[3]
FieldType
IDtext
Deletedboolean

Delete an Organization Webhook

ActionStops event deliveries from an organization.
Input fields[3]
FieldType
OrganizationRequired
choice
Webhook IDRequired
text
Output fields[3]
FieldType
IDtext
Deletedboolean

Invite a Project Member

ActionProject invitation by handle.
Input fields[3]
FieldType
ProjectRequired
choice
HandleRequired
text
Output fields[3]
FieldType
IDtext

Invite a Styleguide Member

ActionStyleguide invitation by email or username.
Input fields[3]
FieldType
StyleguideRequired
choice
HandleRequired
text
Output fields[3]
FieldType
IDtext

Invite an Organization Member

ActionOrganization invitation with a role.
Input fields[3]
FieldType
OrganizationRequired
choice
HandleRequired
text
RoleRequired
choice
RestrictedRequired
boolean
Tagsarray
Itemtext
Output fields[3]
FieldType
Userobject
IDtext
Emailtext
Usernametext
Emotartext
Avatartext
Last Seennumber
Roletext
Tagsarray
Restrictedboolean
Invitednumber

Make an API Call

universalFree-form Zeplin REST API request.
Input fields[3]
FieldType
URLRequired
text
MethodRequired
choice
Headersarray
Headerobject
Query stringarray
Query stringobject
Bodytext
Output fields[3]
FieldType
Bodytext
Headersobject
Keytext
Valuetext
Status codenumber

Remove a Project Member

ActionMember taken off a project roster.
Input fields[3]
FieldType
ProjectRequired
choice
Member IDRequired
text
Output fields[3]
FieldType
IDtext
Deletedboolean

Remove a Styleguide Member

ActionEnds styleguide access for a user.
Input fields[3]
FieldType
StyleguideRequired
choice
Member IDRequired
text
Output fields[3]
FieldType
IDtext
Deletedboolean

Remove an Organization Member

ActionEnds organization access of a person.
Input fields[3]
FieldType
OrganizationRequired
choice
MemberRequired
choice
Output fields[3]
FieldType
IDtext
Deletedboolean

Update a Project

ActionEdits the name, description and status of a project.
Input fields[3]
FieldType
ProjectRequired
choice
Nametext
Descriptiontext
Organizationchoice
Workflow Statuschoice
Linked Styleguidechoice
Clear Fieldschoice
Output fields[3]
FieldType
IDtext
Updatedboolean

Update a Project Color

ActionRecolors a palette entry.
Input fields[3]
FieldType
ProjectRequired
choice
Color IDRequired
text
Nametext
Rednumber
Greennumber
Bluenumber
Alphanumber
Output fields[3]
FieldType
IDtext
Updatedboolean

Update a Project Component

ActionRewrites a component blurb.
Input fields[3]
FieldType
ProjectRequired
choice
Component IDRequired
text
DescriptionRequired
text
Output fields[3]
FieldType
IDtext
Updatedboolean

Update a Project Spacing Token

ActionRenames or revalues a spacing token.
Input fields[3]
FieldType
ProjectRequired
choice
Spacing Token IDRequired
text
Nametext
Valuenumber
Output fields[3]
FieldType
IDtext
Updatedboolean

Update a Project Text Style

ActionRestyles a text preset of a project.
Input fields[3]
FieldType
ProjectRequired
choice
Text Style IDRequired
text
Nametext
Colorobject
RedRequired
number
GreenRequired
number
BlueRequired
number
AlphaRequired
number
Source IDtext
Output fields[3]
FieldType
IDtext
Updatedboolean

Update a Project Webhook

ActionReconfigures a project hook.
Input fields[3]
FieldType
ProjectRequired
choice
Webhook IDRequired
text
URLtext
Nametext
Secretsecret
Statuschoice
Eventschoice
Output fields[3]
FieldType
IDtext
Updatedboolean

Update a Screen

ActionDescribes and tags a design.
Input fields[3]
FieldType
ProjectRequired
choice
ScreenRequired
choice
Descriptiontext
Tagsarray
Itemtext
Clear Fieldschoice
Output fields[3]
FieldType
IDtext
Updatedboolean

Update a Screen Annotation

ActionEdits or moves an annotation.
Input fields[3]
FieldType
ProjectRequired
choice
ScreenRequired
choice
Annotation IDRequired
text
Contenttext
Positionobject
XRequired
number
YRequired
number
Typetext
Clear Fieldschoice
Output fields[3]
FieldType
IDtext
Updatedboolean

Update a Screen Comment

ActionEdits the text of a note reply.
Input fields[3]
FieldType
ProjectRequired
choice
ScreenRequired
choice
NoteRequired
choice
Comment IDRequired
text
ContentRequired
text
Output fields[3]
FieldType
IDtext
Updatedboolean

Update a Screen Note

ActionResolves or moves a note.
Input fields[3]
FieldType
ProjectRequired
choice
ScreenRequired
choice
NoteRequired
choice
Statuschoice
Positionobject
XRequired
number
YRequired
number
X Startnumber
Y Startnumber
Colorchoice
Output fields[3]
FieldType
IDtext
Updatedboolean

Update a Styleguide

ActionRenames or reparents a styleguide.
Input fields[3]
FieldType
StyleguideRequired
choice
Nametext
Descriptiontext
Parent Styleguidechoice
Clear Fieldschoice
Output fields[3]
FieldType
IDtext
Updatedboolean

Update a Styleguide Color

ActionRecolors a shared swatch.
Input fields[3]
FieldType
StyleguideRequired
choice
Color IDRequired
text
Nametext
Rednumber
Greennumber
Bluenumber
Alphanumber
Output fields[3]
FieldType
IDtext
Updatedboolean

Update a Styleguide Component

ActionRewrites a shared component blurb.
Input fields[3]
FieldType
StyleguideRequired
choice
Component IDRequired
text
DescriptionRequired
text
Output fields[3]
FieldType
IDtext
Updatedboolean

Update a Styleguide Spacing Token

ActionRenames or revalues a shared spacing token.
Input fields[3]
FieldType
StyleguideRequired
choice
Spacing Token IDRequired
text
Nametext
Valuenumber
Output fields[3]
FieldType
IDtext
Updatedboolean

Update a Styleguide Text Style

ActionRestyles a shared text style.
Input fields[3]
FieldType
StyleguideRequired
choice
Text Style IDRequired
text
Nametext
Colorobject
RedRequired
number
GreenRequired
number
BlueRequired
number
AlphaRequired
number
Source IDtext
Output fields[3]
FieldType
IDtext
Updatedboolean

Update a Styleguide Webhook

ActionRedirects a library hook.
Input fields[3]
FieldType
StyleguideRequired
choice
Webhook IDRequired
text
URLtext
Nametext
Secretsecret
Statuschoice
Eventschoice
Output fields[3]
FieldType
IDtext
Updatedboolean

Update a User Notification

ActionFlips read state of a notification.
Input fields[3]
FieldType
Notification IDRequired
text
ReadRequired
boolean
Output fields[3]
FieldType
IDtext
Updatedboolean

Update a User Webhook

ActionReconfigures a personal hook.
Input fields[3]
FieldType
Webhook IDRequired
text
URLtext
Nametext
Secretsecret
Statuschoice
Project IDsarray
Itemtext
Styleguide IDsarray
Itemtext
Eventschoice
Output fields[3]
FieldType
IDtext
Updatedboolean

Update an Organization Member

ActionRole and tags of a teammate.
Input fields[3]
FieldType
OrganizationRequired
choice
MemberRequired
choice
Tagsarray
Itemtext
Rolechoice
Restrictedchoice
Clear Fieldschoice
Output fields[3]
FieldType
IDtext
Updatedboolean

Update an Organization Webhook

ActionReconfigures an organization hook.
Input fields[3]
FieldType
OrganizationRequired
choice
Webhook IDRequired
text
URLtext
Nametext
Secretsecret
Statuschoice
Project IDsarray
Itemtext
Styleguide IDsarray
Itemtext
Eventschoice
Output fields[3]
FieldType
IDtext
Updatedboolean

Update User Notifications

ActionBulk read state for notifications.
Input fields[3]
FieldType
Mark As ReadRequired
boolean
Apply to All NotificationsRequired
boolean
Notification IDsarray
IDtext
Typeschoice
Output fields[3]
FieldType
Updatedboolean
Readboolean

Look for Zeplin templates in the WEXTL template library.

Browse templates →
  1. WEXTL® Zeplin Source Code connector implementation.
  2. Our users use cases and automations.
  3. Official API Documentation for Zeplin.
  4. 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.