Webhook

newAlbum

A new album has been created. Triggers when the user account either creates a new album or is added to an existing album.

Payload

dataobjectrequired

albumIdstringrequired

namestringmin 1max 40

ownerIdstring

shareUrlstring

A URL that can be shared with others to view the album. This URL is static and will always point to the album. You can safely cache this URL for future use.

numPhotosinteger

The number of photos in the album

numParticipantsinteger

The number of participants in the album (inclusive of the album owner)

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 newAlbum event fires.

Receiverts

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

Example payload

{"data": {"albumId": "22222222-2222-2222-2222-222222222222",
"name": "My Album",
"ownerId": "11111111-1111-1111-1111-111111111111",
"shareUrl": "https://joinswsh.com/album/abcdef",
"numPhotos": 5,
"numParticipants": 2
},
"metadata": {}
}