Webhook Subscriptions

Modified on Thu, 16 Nov 2023 at 04:35 PM

Webhook Subscriptions enable the receiving of push notifications on specific events as an HTTP POST request to a pre-set URL in Laboperator. For example, you can call a program with a sample number and get the sample information as well as the method parameters for the analysis assigned to that sample back. Every time a selected event is triggered the Webhook will be delivered.


Note: The webhook feature has to be activated by an organizational administrator on the Server Administration level. Also the target URL has to be registered by an organizational administrator.


TABLE OF CONTENTS


Add Webhook Subscription

To add a Webhook Subscription, please follow the steps below:

  1. Click on More.
  2. Navigate to Webhook Subscriptions and click on the three dots in the top right corner and select Add new Webhook Subscription
  3. In the new window:
    1. Type in the Target URL. 
    2. Enter a key and a value.
    3. Click on the button to delete a Header.
    4. Click on ADD HEADER to add additional Headers.
    5. Add a Device by clicking on Selected Channels. In the pop-up window: Type in the name of the Device and afterward choose the Trigger Events based on the channels you have access to  by marking the checkboxes. Click on CONFIRM.
    6. Click on SUBMIT.
  4. You will be redirected to the Webhook Subscription overview.



(De)Activate Webhook Subscriptions

To (de)activate a Webhook Subscription, please follow the steps below:

  1. Click on More. 
  2. Navigate to Webhook Subscriptions and click on the respective toggle button to (de)activate a Webbhook Subscription.



View Webhook Subscription

To view a Webhook Subscription:

  1. Click on More. 
  2. Navigate to Webhook Subscriptions.



Edit/Update Webhook Subscription

To edit/update a Webhook Subscription, please follow the steps below:

  1. Click on More.
  2. Navigate to Webhook Subscriptions and click on the pencil icon besides the Webhook Subscription you want to edit.
  3. In the new window you can change the following:
    1. Change the Target URL. 
    2. Reenter a key and a value.
    3. Click on the button to delete a Header.
    4. Click on ADD HEADER to add additional Headers.
    5. Change the Device by clicking on Selected Channels. In the pop-up window: Type in the name of the Device and afterward choose the Trigger Events based on the channels you have access to  by marking the checkboxes. Click on CONFIRM
    6. Click on SUBMIT.

  4. You will be redirected to the Webhook Subscription overview.



Delete Webhook Subscription

To delete a Webhook Subscription, please follow the steps below:

  1. Click on More.
  2. Navigate to Webhook Subscriptions and click on the trash bin icon besides the Webhook Subscription.

Was this article helpful?

That’s Great!

Thank you for your feedback

Sorry! We couldn't be helpful

Thank you for your feedback

Let us know how can we improve this article!

Select atleast one of the reasons
CAPTCHA verification is required.

Feedback sent

We appreciate your effort and will try to fix the article