---
title: "Configuring Webhooks for Data Sync"
slug: "configuring-webhooks-for-data-sync"
description: "Learn how to configure Webhooks in ScreenMeet to send signed POST requests to your web service, ensuring secure message delivery and integration."
updated: 2021-08-17T20:31:28Z
published: 2021-08-17T20:31:28Z
canonical: "docs.screenmeet.com/configuring-webhooks-for-data-sync"
---

> ## Documentation Index
> Fetch the complete documentation index at: https://docs.screenmeet.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Configuring Webhooks for Data Sync

Webhooks are simple way to post messages from ScreenMeet to your web service. When you configure a Webhook, ScreenMeet will start sending POST HTTP requests to the URL you specify. The content will be signed with a mutual key so that you can verify that the requests are coming from ScreenMeet.

## How to configure

### Retrieve your signing key

1. Sign into the ScreenMeet console as an Administrator
2. Open the top-left menu and click on **Organization -> Integration Signing Key**
3. Click on **Show** then **Copy** to copy your signing key into your clipboard
4. Your application will use this key to verify signed messages from ScreenMeet  
![](https://cdn.document360.io/9da39725-20e5-434f-83a4-d630456099dc/Images/Documentation/image-1628710212633.png)
5. **(optional)** You can reset the signing key by clicking on **Reset Signing Key**

### Configure a Webhook

1. Sign into the ScreenMeet console as an Administrator
2. Open the top-left menu and click on **Organization -> Webhooks**
3. Click on **New Webhook**
4. Enter the **Webhook URL** end-point you wish to send your webhook messages to (must be an https:// protocol)
5. Enter a description for your webhook
6. **(optional)** You can click on **Test** next to the **Webhook URL** to send a test message to your webhook endpoint to test your integration
7. If you wish to start sending traffic to your webhook, toggle **Is Active** to the **ON** state
8. Click **Save**
9. Please note that it may take up to 10 minutes for changes to Webhooks to take affect

## Webhook Request Specification

### Request Properties

| **Property** | **Value** | **Description** |
| --- | --- | --- |
| **Method** | POST | Data is sent via a POST request |
| **URL** | {User Specified} | The URL is the value you enter when configuring your webhook |
| **Body** | JSON Array string | The request is a JSON Array object which contains 1 or more events in the body [ { ...event}, {...event}, ...]. See [Webhook Data Dictionary](/v1/docs/webhook-data-dictionary) for event data definitions. |

### Request Headers

| **Header** | **Value** | **Description** |
| --- | --- | --- |
| Content-Type | text/plain | The content type is intentionally set as text/plain, as many web servers will automatically decode a JSON content type body. In this case, the JSON string signature should first be verified prior to parsing the JSON. |
| x-signature-algo | sha256 | This header contains the signing algorithm used to verify the signature. Currently, sha256 is used. |
| x-signature | string | This is the signature for the request. Your implementation should generate the same signature from the string in the POST body with your secret signing key. The signature should match the one in the x-signature header. |