Skip to main content

Overview

Returns all active webhook subscriptions for your partner account. The webhook secret is never included in list responses — only subscription metadata is returned.

Endpoint

GET /partners/webhooks/subscriptions

Authentication

Requires a valid API Key with the partner_webhooks_manage permission.

Example Request

curl -X GET "https://apiv3.thecleanlife.dev/v1/partners/webhooks/subscriptions" \
  -H "x-api-key: YOUR_API_KEY"

Success Response

HTTP Status: 200 OK
{
  "success": true,
  "data": [
    {
      "id": "gggggggg-0000-0000-0000-000000000001",
      "partnerClientId": "hhhhhhhh-0000-0000-0000-000000000001",
      "url": "https://yourplatform.com/webhooks/cleanlife",
      "events": ["booking.created", "booking.cancelled"],
      "status": "ACTIVE",
      "createdAt": "2026-06-15T10:00:00+03:00",
      "updatedAt": "2026-06-15T10:00:00+03:00"
    }
  ]
}
The secret field is intentionally omitted from all list responses. To get a new secret, use the rotate-secret endpoint.

Error Responses

HTTP StatusCodeDescription
401UNAUTHORIZEDMissing or invalid API key
403FORBIDDENMissing partner_webhooks_manage permission

Notes

  • Only ACTIVE (non-deleted) subscriptions are returned.
  • Results are ordered by creation date descending.

  • POST /partners/webhooks/subscriptions — Create a new subscription
  • PATCH /partners/webhooks/subscriptions/:id — Update a subscription
  • DELETE /partners/webhooks/subscriptions/:id — Delete a subscription
  • POST /partners/webhooks/subscriptions/:id/rotate-secret — Rotate the signing secret