Screen_Shot_2020-03-08_at_17.47.27.png

We now offer the ability to send a webhook via our monday.com integrations! You can send a webhook each time a chosen event occurs within your board. Read on to learn more.

So what is a Webhook?

Webhook (also called a web callback or HTTP push API) is a way for an app to provide other applications with real-time information. A Webhook delivers data to other applications as it happens, meaning you get data immediately unlike typical APIs where you would need to poll for data very frequently in order to get it real-time. This makes Webhooks much more efficient for both provider and consumer.

How to create a new Webhook

Step 1

On your board, click the "integrations" icon and look for the "Webhooks" app while adding new integration.

Once in the integration center, click on Webhooks as below:

Step 2

Choose the action you want the webhook to ״hook״ to :

Step 3

After choosing the action you need, you will need to specify the URL according to the integration that you want to get the webhooks:

From that moment on, using the webhook integration, the API you set will deliver data to other applications, meaning you get data immediately.

How to verify a webhook URL

The URL you specified should be, of course, controlled by your app, and we're verifying that by a verification request we're making while you're listing a new URL.

We will send a json POST body containing a "challenge" field, which is a random token that we expect you to return as a "challenge" field of your response json body to that request.

Here is how the "Challenge" will look like:

The verification request is a POST request to the defined URL with the following payload:

{
 challenge: “3eZbrw1aBm2rZgRNFdxV2595E9CY3gmdALWMmHkvFXO7tYXAYM8P”
}

The response body should be a json object that looks the same:

{
 challenge: “3eZbrw1aBm2rZgRNFdxV2595E9CY3gmdALWMmHkvFXO7tYXAYM8P”
}

How the events will look

Each webhook request post request will have a type field and an event field in its body.

The type field tells you what the events stand for, and the event will contain the payload with the event's data.

Below are a few examples of what these will look like

An example of "when an item is created" :


{
  type: 'create_item',
  event: {
    boardId: 224535,
    groupId: '224132',
    groupName: 'This Week',
    itemId: 983678,
    itemName: 'A new task',
    userId: 103892
  }
}

Here is an example of "when a column value has been updated" :

{
  event: {
    app: 'monday',
    boardId: 224535,
    changedAt: 1564587898.712963,
    columnId: 'status',
    columnType: 'color',
    pulseId: 983678,
    userId: 103892,
    type: 'update_column_value',
    value: {
      label: {
        index: 1,
        text: 'Done',
        style: {
          border: '#00B461',
          color: '#00c875',
          var_name: 'green-shadow'
        }
      }
    },
    previousValue: {
      label: {
        index: 2,
        text: 'Stuck',
        style: {
          border: '#CE3048',
          color: '#e2445c',
          var_name: 'red-shadow'
        }
      }
    }
  }
}

Here is an example of "when an update is sent on an item" :

{
  event: {
    app: 'monday',
    boardId: 224535,
    body: '<p>update text</p>',
    pulseId: 118613172,
    textBody: 'update text',
    userId: 103892
    updateId: 1733892,
    type: 'create_update'
  }
}

Tip: Want to learn more about our integrations and automations? Check out our dedicated support section - link

More assistance

If you need help building custom integrations, we also have an option for paid assistance through our network of certified monday.com partners. If you're interested, please fill out this form and someone will be in touch shortly!

If you have any questions about anything else in this article, feel free to reach out to us at support@monday.com!

Webhook Integration

So what is a Webhook?

How to create a new Webhook

How to verify a webhook URL

More assistance

Comments