Introduction
Web-hooks are used both internally by Shelter buddy and also by external systems.
We use it internally to integrate with Apps/System that are separate from the Shelter buddy monolith.
Setup
Setting up a 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 available from the resources page.
| Name | Description | |
|---|---|---|
| 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. |
Animal Photos
| Anchor | ||||
|---|---|---|---|---|
|
Overview
The Animal Photos Webhook returns photos for any animals that have had their photo added/updated/deleted since the last successful sync. Actions that will be detected by the webhook include:
- Add a photo
- Adding/removing Tags
- Deleting a photo (If no photos are returned, this indicates that all photos have been deleted)
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
| Model | .NET Type |
|---|---|
| AnimalPhotos | |
| ID | int |
| DateLastUpdated | DateTime |
| Photos | ICollection<PhotoModel> |
| PhotoModel | |
| Id | int |
| Animal | ApiReferenceModel<int> |
| IsDefault | bool |
| Photo | Uri |
| PhotoThumbnailFormat | string |
| ApiReferenceModel | |
| Uri | Uri |