Retrieve all webhook subscriptions for the caller

GET /webhook/getSubscriptions
Api key auth

Query parameters

  • limit integer

    The maximum number of webhook subscriptions to retrieve

  • cursor string

    A cursor received from a previous request to retrieve the next page of results

Responses

  • 200 application/json

    Webhook subscriptions retrieved successfully

    Hide response attributes Show response attributes object
    • data array[object] Required
      Hide data attributes Show data attributes object
      • webhookId string Required

        The unique identifier for the webhook subscription

      • config object Required

        The configuration for the webhook subscription, which includes the event type, target URL, and any additional metadata.

        One of:
        WebhookConfigNewPhoto object WebhookConfigNewAlbum object
    • cursor string

      A cursor to be used in subsequent requests to retrieve the next page of results. If this is {}, there are no more results to retrieve.

    • warnings array[string]
GET /webhook/getSubscriptions 
curl \
 --request GET 'https://public-api.joinswsh.com/webhook/getSubscriptions' \
 --header "x-api-key: $API_KEY"
Response examples (200) 
{
  "data": [
    {
      "webhookId": "33333333-3333-3333-3333-333333333333",
      "config": {
        "event": "newPhoto",
        "targetUrl": "https://example.com/webhook",
        "metadata": {},
        "albumId": "22222222-2222-2222-2222-222222222222"
      }
    }
  ],
  "cursor": "string",
  "warnings": [
    "Example warning"
  ]
}