Set Up and Edit Webhooks

You can set up and edit webhook from the Thy Street Dashboard.

Prerequisites

Before you begin, get access to the Thy Street Dashboard by creating an account; make sure you have gone through:

pageCreate DevicepageAPI Credentials

Set up Webhooks

  1. Login into the Thy Street Dashboard and navigate to the Devices page.

  2. Search and click on your device card.

  3. In the Device Integration pop-up page

    1. Enter the URL where you want to receive the webhook payload when an event is triggered. We recommend using an HTTPS URL. You can use other protocols by writing your own custom adapter.

    2. Enter a Secret for the endpoint. The secret is used to validate that the webhook is from Thy Street. Learn more about how to validate and test webhooks.

    3. Click on Save Endpoint to save changes.

Webhook URLs ****Webhooks can only be delivered to public URLs.

All webhook responses must return a status code in the range of 2XX within a window of 6 seconds. If we receive response codes other than this or the request times out, it is considered a failure.

Secret for Webhooks

  • When setting up the Webhooks, you will be asked to specify a secret. Using this secret, you can validate that the webhook is from Thy Street. The Secret should never be exposed publicly.

  • The webhook secret doesn't need to be the API key provided for your account.

Edit a Webhook

You can edit your webhook to replace the webhook URL and modify the secret.

To edit webhooks:

  1. Log into the Thy Street Dashboard and navigate to your Device page

  2. The Device Integration pop-up page is displayed. You can modify the following:

    • Webhook URL

    • Secret

  3. Click on Save Endpoint to save changes.

Next Steps

You should validate and test your webhooks before you go live.

pageValidate and test webhooks

Last updated