Webhooks Documentation for PlanCare 2 version 11.34.0

Introduction

Webhooks allow you to build or set up integrations which subscribe to notifications generated by PlanCare 2. When one of those events is triggered, PlanCare send an HTTP POST payload to the webhook's configured URL.


Available notifications

APIDescription
GET api/webhooks/filters

Retrieves a list of available webhook notifications.


Registrations

APIDescription
GET api/webhooks/registrations

Gets all registrations of the current user.

GET api/webhooks/registrations/{id}

Gets a specific registration.

POST api/webhooks/registrations

Register to a certain notification.

PUT api/webhooks/registrations/{id}

Updates a registration.

DELETE api/webhooks/registrations/{id}

Removes a subscription.

DELETE api/webhooks/registrations

Removes all subscriptions of the current user.


Receiving webhook notifications

Webhook notification

Describes the webhook notification model.