Notification
Resource Description
The webhook notification definition.
| Name | Description | Type | Additional information |
|---|---|---|---|
| Action |
The notification target (For example GroupCalendarAppointment or ClientReport). |
string |
None. |
| Entity |
Identical to Actions. |
string |
None. |
| Type |
The type of mutation (None, Added, Deleted, Modified) |
string |
None. |
| Id |
The id of the PlanCare 2 entity. |
int |
None. |
| Link |
The link to the REST endpoint for retrieval of the entity based on the id. |
string |
Optional. |
| Data |
Additional JSON string sent by PlanCare 2 specific for the entity and type of mutation. |
string |
Optional. |
Format
application/json, text/json
Sample:
{
"Action": "Messaging",
"Entity": "Messaging",
"Type": "Modified",
"Id": 272,
"Link": "https://webapi.deheer-software.nl/PlanCare2Api/PlanCareMessages/272",
"Data": "{\"Subject\":\"Message Subject\",\"To\":\"DHCS\"}"
}