...
We use it internally to integrate with Apps/System that are separate from the Shelter buddy monolith.
All the Webhooks behave basically the same as far as how and when they will Synchronise data.
- The first time a Webhook runs it will typically Synchronise all records of the relevant entity for the Webook.
- Subsequent runs will only send records that have been created or modified since the last Synchronisation.
Setup
Setting up a Webhook requires the ShelterBuddy team to know the URL for the endpoint that you have to handle the post call from the Webhook. Please email support@shelterbuddy.com with your endpoint for this to be set up.
You will need to know what model to expect, the details for the models are available from the resources page.
Notes
The first time a Web-hook runs it may return quite a lot of data as the system will need to sync everything, the data for subsequent runs will reduce as we will only need to send the data added or modified since the last Sync.
Data is returned in batches of 10below.
Available Webhooks
| Name | Description | Following examples can be found at resources look for the Response model. |
|---|---|---|
| DispatchJob | Webhook for dispatch job updates. | DispatchJobV2 |
| AnimalAdoption | Webhook for animal adoption updates. | N/A |
| PhysicalLocation | Webhook for physical location updates. | PhysicalLocationV2 GET api/v2/location/physicallocation/{id} |
| Person | Webhook for person updates. | PersonV2 GET api/v2/person/{id} |
| User | Webhook for user updates. | UserV2 GET api/v2/user/{id} |
| Animal | Webhook for animals. | AnimalV2 GET api/v2/animal/{id} |
| PersonMerge | Webhook for peron merges. | PersonMergeV2 POST api/v2/person/merge/list?page={page}&pageSize={pageSize} |
| AnimalMerge | Webhook for animal merges. | MergeV2 GET api/v2/animal/merge/{id} |
| AnimalIcon | Webhook for animal icons | N/A |
| Animal Photos | Webhook for animal photos. | PhotoV2 POST api/v2/animal/photo/list?page={page}&pageSize={pageSize} |
...
Overview
...
Animal Photos
| Anchor | ||||
|---|---|---|---|---|
|
...