Class webhooks

The authenticity of the webhook can be checked using the HMAC sent along with the request. To set up HMAC verification, follow the instructions here: https://www.qminder.com/docs/api/webhooks/

Calls the HTTP API POST /v1/webhooks.

For example:

import * as Qminder from 'qminder-api';
Qminder.setKey('API_KEY_HERE');
// Example. Add a webhook
const url = 'https://example.com/webhooks/qminder';
const webhook: Webhook = await Qminder.webhooks.create(url);
console.log(webhook.id); // 123
console.log(webhook.secret); // 'hmacSecretText'
// You can use the webhook.secret to check the message validity via HMAC.

throws

ERROR_NO_URL when the URL was not provided

see

Webhook

Removing a webhook will stop all events from being sent to the URL, and removes it from the list of webhooks in the Qminder Dashboard.

Calls the HTTP API DELETE /v1/webhooks/<ID>

For example:

import * as Qminder from 'qminder-api';
Qminder.setKey('API_KEY_HERE');
// Example 1. Remove the webhook with ID 123
await Qminder.webhooks.remove(123);
// Example 2. Create and remove a webhook
const url = 'https://example.com/webhooks/qminder';
const webhook = await Qminder.webhooks.create(url);
await Qminder.webhooks.remove(webhook);

throws

{Error} ERROR_NO_WEBHOOK_ID when the webhook ID is not provided or is not a number