Webhooks

Webhooks

What you will need?

To use this feature you will need:

  1. Subscribed to the Scale plan.
  2. Provision a URL where the data from Teamscope will be sent to.

How webhooks work?

A webhook is a way that one platform (the sender) can send  information to another platform (the receiver) in real-time. For webhook to work the receiver has to create a URL and the sender must send data to that URL whenever an event occurs.

In the case of Teamscope the two events that can trigger a webhook are:

  1. Entry created
  2. Entry updated.

Teamscope will send the data in JSON format to the receiver's URL and the receiver then must parse that data and make the desired use of it.

Enabling webhooks on Teamscope

To enable webhooks click on Study settings on the left menu and the scroll down to Webhooks. Paste the receiver's URL for both Entry created and Entry updated and click Save.

Here is an example of the payload to expect:

Important

The webhook's payload does not include the field item's titles, only the item ID and the data. You can match the item IDs to the corresponding titles by exporting your data to Excel or CSV.

What you will need?

To use this feature you will need:

  1. Subscribed to the Scale plan.
  2. Provision a URL where the data from Teamscope will be sent to.

How webhooks work?

A webhook is a way that one platform (the sender) can send  information to another platform (the receiver) in real-time. For webhook to work the receiver has to create a URL and the sender must send data to that URL whenever an event occurs.

In the case of Teamscope the two events that can trigger a webhook are:

  1. Entry created
  2. Entry updated.

Teamscope will send the data in JSON format to the receiver's URL and the receiver then must parse that data and make the desired use of it.

Enabling webhooks on Teamscope

To enable webhooks click on Study settings on the left menu and the scroll down to Webhooks. Paste the receiver's URL for both Entry created and Entry updated and click Save.

Here is an example of the payload to expect:

Important

The webhook's payload does not include the field item's titles, only the item ID and the data. You can match the item IDs to the corresponding titles by exporting your data to Excel or CSV.