A new album has been created

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

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

application/json

Body Required

  • data object Required
    Hide data attributes Show data attributes object
    • albumId string Required
    • name string

      Minimum length is 1, maximum length is 40.

    • ownerId string
    • shareUrl string

      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.

    • numPhotos integer

      The number of photos in the album

    • numParticipants integer

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

  • 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 newAlbum
Request examples 
{
  "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": {}
}