Webhooks

Introduction

Web-hooks are used both internally by Shelter buddy and also by external parties.

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 the post 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 10.

Available Webhooks

Name	Description	Following examples can be found at resources look for the Response model.
DispatchJob	Webhook for dispatch job updates.	DispatchJobV2 GET api/v2/dispatch/{id}
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}

Animal

Overview

The Animal Webhook will send details of animals that have been created and/or updated.

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)

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.