A label has been added to an Active photo in an album

POST https://webhook.example.com
Api key auth

A label has been added to an Active photo in an album. Requires admin access to the album. Photo label webhooks are rate-limited per photo per label to reduce the risk for recursive calls.

application/json

Body Required

  • data object Required
    Hide data attributes Show data attributes object
    • photoId string Required
    • width integer
    • height integer
    • originalUrl string Required

      A signed URL to access the uploaded image. For videos, this is a thumbnail image.

    • stableUrl string Required

      A signed URL to access the stable version of the image (JPEG or WebP, <15 MB) or a thumbnail of the video (JPEG or WebP, <15 MB)

    • videoUrl string

      A signed URL to access the originally uploaded video. Only present if the photo is a video or live photo.

    • downloadUrl string Required

      A signed URL to download the original file (image or video) as it was uploaded. This URL is either the originalUrl or originalVideoUrl, depending on the media type.

    • labels array[string]

      The labels associated with the photo

    • restrictedLabels array[string]

      The labels associated with the photo that are hidden from non-admin users

  • metadata object

    Additional metadata included in the webhook request. This can be used to pass custom data to the webhook handler. Valid value types are string, number, and boolean.
POST photoLabelAdded
Request examples 
{
  "data": {
    "photoId": "string",
    "width": 42,
    "height": 42,
    "originalUrl": "string",
    "stableUrl": "string",
    "videoUrl": "string",
    "downloadUrl": "string",
    "labels": [
      "string"
    ],
    "restrictedLabels": [
      "string"
    ]
  },
  "metadata": {}
}