Webhooks
Introduction
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.
- However, a Webhook can be configured to sync all records or have it start syncing changes from now on.
- Subsequent runs will only send records that have been created or modified since the last Synchronisation.
- Data is sent in batches.
Setup
Setting up a Webhook requires the ShelterBuddy team to know the URL for the endpoint that you have to handle the 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 below.
Available Webhooks
| Name | Description | Following examples can be found at resources look for the Response model. |
|---|---|---|
| DispatchJob | Webhook for dispatch job updates. | DispatchJobV2 |
| 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} |
| AnimalDelete | Webhook for animal deletes | DeleteV2 GET api/v2/animal/Delete/{id} |
| AnimalIcon | Webhook for animal icons | Model {
isActive,
isPublic,
Uri,
LastUpdatedUtc,
Extension
}
|
| Animal Photos | Webhook for animal photos. | PhotoV2 POST api/v2/animal/photo/list?page={page}&pageSize={pageSize} |
Animal Photos
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)