...
We use it internally to integrate with Apps/System that are separate from the Shelter buddy monolith.
Setup
Setting up a webhook Webhook requires the ShelterBuddy team to know the URL for the endpoint that you have to handle receiving animal photos. Please email support@shelterbuddy.com with your endpoint for this to be set up.
You will need to know what model to expect, the model is called “AnimalPhotos” and is 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 date data added or modified since the last Sync.
Data is returned in batches of 10.
Available Webhooks
| Name | Description | Following examples can be found at resources |
|---|---|---|
| DispatchJob | Webhook for dispatch job updates. | |
| AnimalAdoption | Webhook for animal adoption updates. | |
| PhysicalLocation | Webhook for physical location updates. | |
| Person | Webhook for person updates. | |
| User | Webhook for user updates. | |
| Animal | Webhook for animals. | |
| PersonMerge | Webhook for peron merges. | |
| AnimalMerge | Webhook for animal merges. | |
| AnimalIcon | Webhook for animal icons | |
| Animal Photos | Webhook for animal photos. | Example of Response Model is under: PhotoV2 POST api/v2/animal/photo/list?page={page}&pageSize={pageSize} |
Animal Photos
| Anchor | ||||
|---|---|---|---|---|
|
...
The first time this webhook runs it may send through quite a lot of data as the last successful sync date will be null. Data is sent through in a paged fashion in batches of 10 records.
Model Returned
...