Send Ziflow Events Data Using Webhook Zibot

Execute API requests for other web-based applications offering API functionality.

Updated over a week ago

Summary: Having the ability to keep your projects in sync as proofs progress through the review and approval workflow, or being able to create proofing tasks for reviewers in your PM tool is a valuable component that Ziflow offers. We are actively working on extending our Zibots and integrations platform.

Available for: Users with Admin rights on Standard, Pro & Enterprise editions.

Our Webhook Zibot allows you to trigger a flow when the following events occur on a proof:

  • New proof/version: triggers when a new proof is ready for review.

  • Decision: triggers when a decision is made by a reviewer or when a decision is updated on the stage and/or proof.

  • New comment/reply: triggers when a reviewer adds a comment/reply to the proof.

  • Comment resolved: triggers when a comment is marked as resolved.

  • Comment labeled: triggers when a reviewer labels a comment.

  • Proof updated: triggers when the proof folder, setting, or custom property changes.

  • Stage updated: triggers when a stage is started or when a reviewer is added/removed.
    ​

  • Comment reaction: triggers when a comment reaction is added on a comment/reply level.

Follow the instructions on how to:


Connect Ziflow application

You'll need to build the automation by adding a new Ziflow app connection. This application will be responsible for performing different proof actions on your behalf.

Go to Connect -> Applications and then click on the + Connect Application button in the upper right corner.

Connect application button in Ziflow

Once you click on the connect button, select Ziflow from the list. You'll need to name the connection and enter your API key.

Configuration Ziflow as an application and add the API key

Create Flow

Click on the Connect tab in the upper left corner of the screen, then click on the + Create flow button. Instead of connecting to cloud storage, select the Ziflow application.

Create flow with Ziflow as an application

Set up Flow Event settings.

The first step is selecting the event that will trigger your Zibot:

Set up Flow Event settings in Ziflow

Next, you will be presented with the event details page, which will vary depending on which event you select:


New proof/version

New proof/version event settings in Ziflow
  1. Triggered by - select the type of request that will trigger the Zibot.

  2. Created in - select the Ziflow folder that this flow will monitor.

  3. Created by - select the user that will be responsible for this flow activation.


Decision made

Decision made event settings in Ziflow
  1. Triggered by decision made - select what level decision needs to be made to activate the flow.

  2. Type of decision - choose the type of decision that needs to be made to activate the flow.

  3. Created in - select the Ziflow folder that this flow will monitor.


New comment/reply added

New comment/reply added event settings in Ziflow
  1. Triggered by new comment / new reply - choose which option should activate the flow.

  2. Made by - choose if a Zibot should be activated by a specific reviewer or by anyone that adds a comment/reply.

  3. Created in - select the Ziflow folder that this flow will monitor.


Comment resolved

Comment resolved event settings in Ziflow
  1. Created in - select the Ziflow folder that this flow will monitor.


Comment labeled

Comment labeled event settings in Ziflow
  1. Comment is labeled as - select which label(s) should trigger a Zibot.

  2. Created in - select the Ziflow folder that this flow will monitor.


Proof updated

Proof updated event settings in Ziflow
  1. Triggered by - select which type of the proof updated event should trigger the Zibot.

  2. Modified in - choose the Ziflow folder that this flow will monitor.


Stage updated

Stage updated event configuration
  1. Triggered by - select which type of the stage updated event should trigger the Zibot. There are three types of stage update events: reviewer added, reviewer removed, stage locked, and deadline changed.

  2. Modified in - choose the Ziflow folder that this flow will monitor.


Comment reaction

Comment reaction event settings
  1. Triggered by - choose if you want to trigger a flow based on reactions added to comments or replies.
    ​

  2. Comment reacted with - select what type of reaction should trigger a flow.
    ​

  3. Created in - select the Ziflow folder that is going to be monitored by this flow.


Set up Zibot details.

Decide what should be done with information from the selected event:

  1. Webhook Zibot (Pro & Enterprise editions)- will pass information from Ziflow to external apps/services.

  2. Ziflow internal Zibots (Standard, Pro & Enterprise editions) b- can be used to perform automated changes on proofs in Ziflow.

  3. Paths (Pro & Enterprise editions)- execute different Zibots based on one or more conditions.

Webhook Zibot

Choose a Webhook Zibot if you want to send Ziflow metadata to some external service or app:

Webhook Zibot

Configure Webhook with data that you want to pass over:

Webhook Zibot configuration in Ziflow
  1. Create - select the type of request that you want to send to the 3rd party app. There are five different request types that you can choose from: GET, POST, PUT, PATCH, and DELETE.

  2. URL (required) - enter the application URL where you will send the data.

  3. Query String Parameters - add which parameters you want to send.

  4. Request body - enter a payload of the body using JSON format.

  5. Headers - enter the header values for each request.

Once you hit the Next button, Ziflow will confirm if the flow looks good. If there are no problems, name the flow and turn it on.

Name your flow in Ziflow

Ziflow internal Zibots

If you want to automate some of the actions inside Ziflow, you may find these Zibots very useful. They can help you automatically perform some changes on proofs. To enable these Zibots, you need to connect the Ziflow application to your account.

Ziflow internal Zibots

We have four different internal Zibots that could be used in various scenarios:

Each of them has a unique ability to perform needed changes on proofs.


Update proof custom property.

Update proof custom property Zibot settings

With this Zibot, you can set/change a property that is assigned to a particular project.


Add proof integration property.

This Zibot is useful if you want to connect proofs with items (projects, tasks, etc) from applications you've integrated with Ziflow.

 Add proof integration property

Check multiple stages statuses.

Check multiple stages statuses Zibot settings

This Zibot lets you check the status of the proof stage and then perform the required action with that information. Here's an example of how such Zibot can automate work for you.


Start a stage.

Start a stage Zibot settings

This Zibot can kick off stages starting with a particular name.


Add reviewer.

Add reviewer Zibot settings

Allows adding reviewers to the chosen stage. It also lets you select reviewer proof permissions & notification preferences.


Turn minor version on/off.

Turn minor version on/off Zibot

Let's turn on/off a minor version on a proof level. Read more about using minor/major versions.


Replace/Append workflow.

Replace/Append workflow Zibot

With this Zibot, you can adjust the workflow template on a proof. Learn more about configuring and using Workflow Templates in Ziflow.

Please keep in mind that there are certain limitations to the Ziflow edition you are using when utilizing this Zibot. The maximum number of stages in a proof is limited based on your Ziflow edition, so if you attempt to append or replace a workflow that goes beyond the maximum stage limit, the flow will not succeed. It's important to be aware of these limitations to avoid any issues while using the Zibot.


Send Email.

Send Email Zibot in Ziflow

With Send Email Zibot, you can send email notifications when a flow event is triggered. However, there are several fields that require configuration.

  1. From name - provide a name that you would like to appear in the "from name" field of the email. You can also use a token selector to automatically input the email address of the proof owner.

  2. From email - select a "from email" that the message should be sent from. If you have configured your own custom domain mapping, you should be able to select email from your domain configuration.

  3. To recipients - enter email address/s manually or select them using a token selector.

  4. Subject - input a subject line for your email.

  5. Message - compose an email message. You can also utilize a token selector to incorporate some metadata for better context.

  6. CC recipients - include additional recipients by adding them as carbon copy recipients to your email.

  7. BCC recipients - to add more recipients to your email, you can include them as BCC recipients.

  8. Reply to - it's important to set a designated "reply to" address to ensure that any email responses go to the right place.


Additional information:

  • Along with sending a simple Webhook call to your 3rd party app, you can also utilize Paths, which allows executing different Zibots based on one or more conditions. Read more about paths in this article.


    ​

    Path configuration in Ziflow

  • Notice that you can refer to the data from the proof or other Zibots in all input fields of the Webhook using JSONPath syntax. Please see our API reference page for more details and examples of our JSONPath syntax.

Did this answer your question?