Skip to main content

 

Documentation & User Guides | FotoWare

Configuring notifications when assets change

Using webhooks you can configure the FotoWare system to to send notifications when assets change in an archive. These notifications are configured in the FotoWeb site settings in the Operations Center, in the Firehose section.

Three asset events are available for notifications:

Asset ingested - Used to post a notification when an asset enters the system by any method.

Asset modified - Send a notification when an asset in the system changes.

Asset deleted - Send a notification when an asset is deleted by any means.

The asset data can be sent as Form or JSON data to the URL specified in the corresponding field.

JSON Data sent in webhook

Attribute

Type

Description

byline String The byline of the asset
created ISO 8601 Date (String) Date when webhook was created
data JSON object Asset representation
description String Description of the asset
file-size String Size of the file in bytes
href String Original URL of the asset within the originating archive
id String ID of the webhook
pixel-height String A height of the image in pixels, e.g. "2560"
pixel-width String A width of the image in pixels, e.g. "1440"
preview-href String URL of the preview image
tags String Tags (keywords) of the asset
thumbnail-href URL (String) URL of the thumbnail
title String Title of the asset
type String Type of the data. In this case, it's "asset"
unc-path String Deprecated. Please do not use. Not available in SaaS

Example of the JSON data sent in webhook

Please note that the "data" field below contains the Asset representation. Because of its size, it has been left out in the example.

JSON

{

  "pixel-width": "2976",

  "byline": "",

  "description": "Some long description line",

  "tags": "",

  "file-size": "243340",

  "title": "",

  "thumbnail-href": "https://acme.fotoware.cloud/fotoweb/cache/5473/like/IMG_20190223_135249.t5c80f612.m200.x0UnqgdCS.jpg",

  "created": "2019-03-07T11:44:27.802Z",

  "href": "https://acme.fotoware.cloud/fotoweb/archives/5473-SummitPhotos/like/IMG_20190223_135249.jpg.info",

  "data": {...},

  "preview-href": "https://acme.fotoware.cloud/fotoweb/cache/5473/like/IMG_20190223_135249.t5c80f612.m800.xYQhD8Ty-.jpg",

  "type": "asset",

  "unc-path": "...",

  "pixel-height": "3968",

  "id": "12489453-7e9d-4604-af89-99b8f91db6a3"

}