Webhook

photoLabelAdded

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.

Payload

dataobjectrequired

photoIdstringrequired

widthinteger

heightinteger

originalUrlstringrequired

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

stableUrlstringrequired

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)

videoUrlstring

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

downloadUrlstringrequired

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.

labelsArray<string>

The labels associated with the photo

string

restrictedLabelsArray<string>

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

string

metadataobject

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.

How to receive

Create a webhook subscription via the createSubscription endpoint. We'll POST the payload above to your configured URL whenever the photoLabelAdded event fires.

Receiverts

// Express-style handler
app.post("/webhooks/photoLabelAdded", (req, res) => {
  const event = req.body;
  // ...handle the event
  res.status(200).end();
});

Example payload

{"data": {"photoId": "string",
"width": 0,
"height": 0,
"originalUrl": "string",
"stableUrl": "string",
"videoUrl": "string",
"downloadUrl": "string",
"labels": ["string"
],
"restrictedLabels": ["string"
]
},
"metadata": {}
}