Ctrlk
WebsiteContact Support
For the complete documentation index, see llms.txt. This page is also available as Markdown.

SharinPix Webhook Payload

This article gives examples of the different payloads available for events specified in SharinPix Webhook. These events are:

Tip:

For more information about the events listed above, please refer to the following:

Server-side Events

New image

The SharinPix Webhook Payload for the New image event is as shown below:

id: f37e01b7-942c-4179-bfd0-0cccf4700328
public_id: f37e01b7-942c-4179-bfd0-0cccf4700328
metadatas: {}
width: 3786
height: 4733
rotation: 0
gps: 
size: 1526906
format: jpg
original_url: <Image's original URL>
filename: NorthBuilding
created_at: '2020-08-12T08:18:57.549+02:00'
taken_at: 
infos:
  format: jpg
page: 1
group_id: 
exifs:
  DateTimeOriginal: 
processed: true
processing_error: 
album_id: 0WOB0000000YsjGOAS
thumbnails:
  full: <URL displaying image in full format>
  large: <URL displaying image in large format>
  mini: <URL displaying image in mini format>

In the payload above, information regarding the newly added image is given such as, its ID, dimensions, format, album ID as well as related thumbnail URLs.

Processed image

The SharinPix Webhook Payload for the Processed image event is as shown below:

New tag image

The New tag image event is triggered when images are tagged with either pre-defined tags or any tags. The payload is as follows:

The above payload provides information about the tag, the tagged image and the user who applied the tag.

Delete image

The Delete image event's payload provides information about the deleted image as shown below:

Delete tag image

The Delete tag image event's payload provides information about the removed tag, the image for which tag has been omitted as well as information about the user who performed the action. The payload is presented below:

Upload done

An example of the Upload done event's payload for image upload via a mobile device is given below:

The payload consists of:

  • app_url: Provides the deeplink to the SharinPix app

  • count: Gives the number of images captured

  • platform: Indicates whether the images were captured from the web or a mobile device. In this case the image was uploaded using a mobile device

  • album_id: Gives the album ID

  • image_ids: Gives the public IDs of the images captured

The payload obtained for an Upload Done event when images are uploaded via the web differs slightly as shown below:

New einstein prediction

The Einstein prediction event's payload is as shown below:

The payload provides information about the model, the image ID as well as the calculated probabilities.

PreviousSharinPix WebhooksNextDuplicate a SharinPix album using a Flow (Admin-Oriented)