Webhooks provides a mechanism to receive notifications whenever particular changes happen so that you can take necessary actions on your end. It enables creating apps that react to changes in Zeplin in real-time. Changes in Zeplin projects such as adding a new screen, updating a component, or a new reply to comment; or updates within Zeplin organizations such as new members, role changes. Zeplin Webhooks bring a wide variety of notifications to your applications in the form of HTTP requests.
You can create webhooks from your profile on the Web app, under the "Developer" tab: https://app.zeplin.io/profile/developer
If your team is on the Organization plan, to create webhooks, click the settings button on the top right of your organization dashboard to access the “Developer” tab.
☝️ Only those with an Admin role or higher can access the Organization Developer tab.
Creating a webhook is pretty simple. What you need is:
- URL of your webhook application. This is where Zeplin will send POST requests when an event is triggered.
- A secret. The shared secret is used as the key to sign webhook requests so that you can verify that events are originally coming from Zeplin. Check out the Securing Webhook Requests section for more details.
You can Subscribe to all events happening in the workspace, or Select individual events and filter projects and styleguides so that your webhook receives notifications for changes in only a select list of projects and styleguides. Check out our webhook guide and webhook events reference for more information.
When you create a webhook, we'll send a ping request to your endpoint to make sure that it's accessible and ready to use. You can activate webhooks only if they're responding ping events from Zeplin, so you can activate later if your application is not live yet.
Fill out the form as you need it and create the webhook. Voila! Now your application is ready to be notified of Zeplin events!
Creating webhooks via Zeplin apps
Zeplin apps can create webhooks on user’s behalf to build powerful integrations, using webhook endpoints of our API.
Check out our API documentation to learn more about webhook endpoints.