Retrieve all webhook subscriptions for the caller

GET/webhook/getSubscriptions

Authentication

Include your API key in the x-api-key header on every request.

Query parameters

limitinteger≥ 1≤ 64default: 32

cursorstring

Response · 200 Webhook subscriptions retrieved successfully

dataArray<WebhookConfig>required

object

webhookIdstringrequired

The unique identifier for the webhook subscription

configWebhookConfigNewPhoto | WebhookConfigNewAlbum | WebhookConfigPhotoLabelAddedrequired

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

WebhookConfigNewPhoto

WebhookConfigNewAlbum

WebhookConfigPhotoLabelAdded

cursorstring

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.

warningsArray<string>

string

TypeScript SDKts

import { SwshApiClient } from "@somewhere-somehow/swsh-public-api";

const client = new SwshApiClient({ apiKey: process.env.SWSH_API_KEY! });

const result = await client.webhook.getSubscriptions({
  limit: 10,
  cursor: "value"
});

cURLbash

curl "https://public-api.joinswsh.com/webhook/getSubscriptions?limit=10&cursor=value" \
  -H "x-api-key: $SWSH_API_KEY"

Example response

{"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"
]
}