Contents x
    Configuring Webhooks for Data Sync
    • 17 Aug 2021
    • 1 Minute to read
    • Print
    • Dark
      Light
    • PDF
    Contents

    Configuring Webhooks for Data Sync

    • Updated on 17 Aug 2021
    • 1 Minute to read
    • Print
    • Dark
      Light
    • PDF
    Article summary

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

    PropertyValueDescription
    MethodPOSTData is sent via a POST request
    URL{User Specified}The URL is the value you enter when configuring your webhook
    BodyJSON Array stringThe request is a JSON Array object which contains 1 or more events in the body [ { ...event}, {...event}, ...]. See Webhook Data Dictionary for event data definitions.

    Request Headers

    Header
    		ValueDescription
    Content-Type
    		text/plainThe 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
    		sha256This header contains the signing algorithm used to verify the signature. Currently, sha256 is used.
    x-signature
    		stringThis 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.
    Was this article helpful?
    What's Next