How To - Integrate with Monday.com

    Summary: With our monday.com integration SDK you are able to extend your Ziflow online proofing operations to automatically create and update tasks in real-time updates in Monday for new proofs, comments, decisions, and more to keep your team up to date in the tools they're already working in. 

    Where is the feature applied? To integrate Monday with Ziflow you need to click on the “Zibots” tab and then click on the “+ Create Flow” button, choose "Ziflow" as the Application and choose which Event (new proof/version, decision made, new comment/reply, comment resolved, comment labeled) you want to trigger the integration.

    image8-7

    image6-16

    How does it work?

    Step 1: Set up the details for the Event that will trigger the integration. This allows you to more finely control when the integration will send real-time updates to monday.com. The most common event trigger for the integration are:

    • 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.

    2019-05-03_14h12_26

    Step 2: You will be presented with the event details page, which will vary depending on which event you select. This allows you to more finely control when the integration will send real-time updates to monday.com.

    image2-62

    1. Triggered by - select the type of request that will trigger the Zibot.
    2. Created in - select the Ziflow folder that will be monitored by this flow.
    3. Created by - select the user that will be responsible for this flow activation.

    image5-22

    1. Triggered by decision made - select what level decision needs to be made in order to activate the flow.
    2. Type of decision - choose the type of decision that needs to be made in order to activate the flow.
    3. Created in - select the Ziflow folder that is going to be monitored by this flow.

    2019-05-03_14h13_16-1

    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 is going to be monitored by this flow.

    Step 3: choose the Webhook Zibot:

    image4-37

    Step 4: Under Create, select POST. Under URL, type in "https://api.monday.com/v2?". Under Headers, type in "Authorization" for the key and your Monday.com API key for the value (NOTE: if you don't have a Monday.com API token, you will need to access it from your monday.com account; please see the Additional Information below for more details). Click +Add under Headers, for the key type in "Content-Type" and "application/json" for the value.

    Copy the below SDK and update {YourMondayBoardId} (NOTE: if you do not know your Monday.com Board ID, please see the Additional Information below for more details) in the Request body section. 

    To automatically create a new task on a board in monday.com when an event occurs on a proof in Ziflow:

    {
    "query":"mutation {create_item (board_id: {YourMondayBoardId}, item_name: \"{$.proof.name}\"){board{id}, id}}",
    "variables":null
    }

    Step 5: Click + under the Webhook you just created to create another webhook.

    Under Create, select POST. Under URL, type in "https://api.monday.com/v2?". Under Headers, type in "Authorization" for the key and your Monday.com API key for the valueClick +Add under Headers, for the key type in "Content-Type" and "application/json" for the value.

    Copy the below SDK Request body section.

    {
    "query":"mutation {create_update (item_id: {$.zibot[0].data.data.create_item.id}, body: \"There is new proof to review: {$.proof.public_link} \") {id} }",
    "variables":null
    }

    Step 6: 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.

    image1-54

    And, you're done! Ziflow will now send automatically create a task to your desginated Monday.com board.


    Additional information:

    Supporting Material: