List your webhooks

Overview

See every active subscription for your partner.

Use this to check what's set up, or to find a subscription's id.

You'll need a partner token.

Returns each subscription with its URL, type, filter, and status, newest first. Deleted subscriptions aren't listed. The signing secret isn't included; use Show the current secret for that.

Prerequisites

A Partner bearer token. See Authentication.

Base URL

Environment	URL
Production	`https://production-api.shoutaboutus.com`
Development	`https://development-api.shoutaboutus.com`

Endpoint

GET /api/v1/partner/webhooks

Authentication

Partner token

Only partner users can call it; other tokens get 403.
Lists only your own partner's subscriptions.

Rate limit

This endpoint has no rate limit.

Request parameters

None.

Request body

None.

Request payload

None.

Response body

The payload is inside data.

Field	Type	Description
`data`	array of objects	Your subscriptions, newest first. Empty when you have none.
`data[].id`	integer	The subscription's id (`webhookSubscriptionId`).
`data[].partner_company_id`	integer	Your partner id.
`data[].label`	string	Your name for the subscription.
`data[].webhook_url`	string	Where deliveries are sent.
`data[].events`	array of strings or null	The event filter. `null`: all immediate events. Always `null` on a batch subscription.
`data[].payload_mode`	string	`full` (the review, who did it, and the history entry) or `minimal` (event name and ids only). Always `full` on a batch subscription.
`data[].delivery_kind`	string	`immediate` (each event as it happens) or `batch` (one `cache_invalidation` ping per location per interval).
`data[].batch_interval_hours`	integer or null	Hours between batches: `1`, `2`, `4`, `6` or `12`. `null` on an immediate subscription.
`data[].delivery_label`	string	The delivery type in words: `immediate`, `hourly batch` or `every N hours`.
`data[].last_batch_dispatched_at`	string or null	When the last batch was sent (ISO 8601). Set to the creation time for a new batch subscription; `null` on an immediate one.
`data[].is_active`	boolean	Whether deliveries are being sent.
`data[].hmac_secret_fingerprint`	string	The first 16 characters of the SHA-256 hash of the signing secret, so you can tell which secret is current. The secret itself is never returned here.
`data[].last_succeeded_at`	string or null	When a delivery last succeeded (ISO 8601), or `null`.
`data[].last_failed_at`	string or null	When a delivery last failed (ISO 8601), or `null`.
`data[].last_failure_reason`	string or null	Why the last delivery failed, or `null`.
`data[].consecutive_failure_count`	integer	Failed deliveries in a row since the last success.
`data[].created_at`	string	When the subscription was created (ISO 8601).
`data[].updated_at`	string	When it last changed (ISO 8601).

Response payload

{
  "data": {
    "data": [
      {
        "id": 4,
        "partner_company_id": 5,
        "label": "Nightly refresh",
        "webhook_url": "https://partner.example.com/hooks/sau-batch",
        "events": null,
        "payload_mode": "full",
        "delivery_kind": "batch",
        "batch_interval_hours": 4,
        "delivery_label": "every 4 hours",
        "last_batch_dispatched_at": "2026-06-16T14:00:00+00:00",
        "is_active": true,
        "hmac_secret_fingerprint": "335b947fe611b6b2",
        "last_succeeded_at": "2026-06-16T14:00:02+00:00",
        "last_failed_at": null,
        "last_failure_reason": null,
        "consecutive_failure_count": 0,
        "created_at": "2026-06-16T10:30:00+00:00",
        "updated_at": "2026-06-16T10:30:00+00:00"
      },
      {
        "id": 3,
        "partner_company_id": 5,
        "label": "Production webhook",
        "webhook_url": "https://partner.example.com/hooks/sau",
        "events": [
          "review_pull_connected",
          "review_pull_disconnected",
          "usage.limit_reached"
        ],
        "payload_mode": "full",
        "delivery_kind": "immediate",
        "batch_interval_hours": null,
        "delivery_label": "immediate",
        "last_batch_dispatched_at": null,
        "is_active": true,
        "hmac_secret_fingerprint": "587647e874083b23",
        "last_succeeded_at": "2026-06-16T10:27:30+00:00",
        "last_failed_at": null,
        "last_failure_reason": null,
        "consecutive_failure_count": 0,
        "created_at": "2026-06-16T10:23:23+00:00",
        "updated_at": "2026-06-16T10:23:23+00:00"
      }
    ]
  }
}

Examples

Success payload

See Response payload.

Error payload

403 Not a Partner token

{
  "message": "Only partner-admin users can manage webhook subscriptions.",
  "status": "error",
  "errors": []
}

500 Server error

{
  "message": "Server Error"
}

Status	Meaning
`200`	Your subscriptions.
`401`	The token is missing, expired or invalid.
`403`	The token isn't a Partner token.
`500`	Unexpected server error.

Example request

curl --request GET \
  --url "https://production-api.shoutaboutus.com/api/v1/partner/webhooks" \
  --header 'Authorization: Bearer <bearer-token>' \
  --header 'Accept: application/json'