Webhooks

Webhooks are configured and enabled in Settings > General > Integrations > Webhooks.

• Webhooks are HTTP POST requests to the URL defined in the settings for each webhook

• The POST request has data identifying what type of data was updated, and the ID of the object

  • Example: “consultation_id=123”

• Webhooks expect to receive HTTP 200 response on the successful process

  • If the response is other than HTTP 200, the notification delivery will be retried

  • On the settings page, you can see also an up-to-date list of triggered webhooks and their delivery status. A log is available for review.

• Webhooks can be set to be department specific, in which case they only trigger when items on a certain department are updated, or can be set to be organization-wide, in which case they always trigger.

  • Leaving the department field empty will make the webhook work across the entire organization.

  • Certain actions where departments cannot be inferred, such as updating clients and patients through the REST API, do not trigger department-specific webhooks.

• Multiple webhooks can be set for the same trigger and/or department, and updates will trigger all of the webhooks that apply in the situation.

• Webhooks can be given an optional name to help identify and differentiate them.

• No longer needed webhooks can be disabled by unchecking the Active checkbox.

The Webhook events currently available can be seen in Provet Cloud settings. Each of the hooks can have a different (or same) URL address, to which Provet Cloud sends the hook when triggered by the event.