Configuring Webhooks

As an admin user, you can manage all Webhooks configured for your system.

Overview

Webhooks are "user-defined HTTP callbacks". They are usually triggered by an event, such as starting or stopping a recording. When the event occurs, VADAAR makes an HTTP request to the URL configured for the webhook, the action taken may be anything. Common uses are to trigger tools that can monitor an environment or populate bookmarks for a recording.

Creating Webhooks

Prerequisite

You must log in with an Administrator account to create webhooks.

To create a webhook in VADAAR:

1. Navigate to Settings > Webhooks.
2. In the top Webhooks ribbon, select Add.
3. In the Add Webhooks dialog, enter the URL for the webhook.
4. (Optional) In the Header fields, enter a Key and a Value.
5. (Optional) Add additional headers, if needed.
6. Select Ok.

Result: The webhook is created with the entry added to the bottom of the webhooks list and is ready for use.

Editing Webhooks

Prerequisite

You must log in with an Administrator account to create webhooks.

To edit a webhook in VADAAR:

1. Navigate to Settings > Webhooks.
2. In the list of Webhooks, select a webhook to edit.
3. In the top Webhooks ribbon, select Edit. Alternatively, select the pencil icon under Actions.
4. In the Edit Webhooks dialog, update the necessary information.
5. Select Ok.

Result: The webhook entry is updated with the new information.

Deleting Webhooks

Prerequisite

You must log in with an Administrator account to create webhooks.

To delete a webhook in VADAAR:

1. Navigate to Settings > Webhooks.
2. In the list of Webhooks, select a webhook to delete.
3. In the top Webhooks ribbon, select Delete. Alternatively, select the trash can icon under Actions.
4. In the Delete webhook? dialog, select Delete.

Result: The webhook entry is removed from the webhooks list.

Webhook Endpoint Tips

If you are writing your own endpoint (web server) to receive VADAAR webhooks, consider the following:

• Your endpoint should send its HTTP response as fast as possible to allow VADAAR to continue processing other events.
• Your endpoint should ALWAYS return a valid HTTP response.
  • If a valid response is not returned, VADAAR thinks the hook failed. Most HTTP libraries automatically check for you, but if you are writing a low-level hook this is important to remember.

Events

Recording Event

Triggers when you start/stop recording items.

Request header:

X-VADAAR-Event: RecordingEvent

Request body:

[
  {
    "recordingItemId": 1,
    "dateCreated": "0001-01-01T00:00:00",
    "dateUpdated": "0001-01-01T00:00:00",
    "dateStarted": null,
    "dateStopped": null,
    "state": "fatal",
    "inputId": 0,
    "outputId": null,
    "recordingSessionId": 0
  },
  {
    "recordingItemId": 2,
    "dateCreated": "0001-01-01T00:00:00",
    "dateUpdated": "0001-01-01T00:00:00",
    "dateStarted": null,
    "dateStopped": null,
    "state": "fatal",
    "inputId": 0,
    "outputId": null,
    "recordingSessionId": 0
  }
]