Show one subscription

Overview

Get a single webhook subscription scoped to the caller's partner. Returns 404 (not 403) when the row exists but belongs to another partner — minimises ID leakage. No raw secret material is exposed.

Prerequisites

A bearer token. Callable with Partner tokens.
The webhookSubscriptionId of the record you are targeting.

Base URL

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

Endpoint

GET /api/v1/partner/webhooks/{webhookSubscriptionId}

Authentication

Requires a bearer token in the Authorization: Bearer <bearer-token> header.
Who can call it: Partner tokens.
findCallerSubscription calls requirePartnerCompanyId (403 unless bundle_id === 1) then loads the row WHERE id AND partner_company_id = caller's company.
Missing falls back to 404.

Rate limit

No rate limit.

Path parameters

Parameter	Type	Required	Description
`webhookSubscriptionId`	integer	Required	Digits only.

Response

200 Success · `200`

{ "data": { "data": {
  "id": 2,
  "partner_company_id": 5,
  "label": "example_label",
  "webhook_url": "https://example.com/webhook",
  "events": null,
  "payload_mode": "full",
  "delivery_kind": "batch",
  "batch_interval_hours": 4,
  "delivery_label": "every 4 hours",
  "last_batch_dispatched_at": "2026-06-16T10:23:23+00:00",
  "is_active": true,
  "hmac_secret_fingerprint": "587647e874083b23",
  "last_succeeded_at": null,
  "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"
} } }

Errors

Status	Meaning
`401`	The bearer token is missing, expired or invalid
`403`	The caller is not a partner-admin user (`Only partner-admin users can manage webhook subscriptions.`)
`404`	No subscription matches the id — including a subscription owned by another partner
`500`	Unexpected server error

Example request

curl --request GET \
  --url "https://production-api.shoutaboutus.com/api/v1/partner/webhooks/123" \
  --header 'Authorization: Bearer {{bearerToken}}' \
  --header 'Accept: application/json'

Updated 11 days ago

Did this page help you?