Skip to main content
GET
Get a subscription

Authorizations

Authorization
string
header
required

API key passed as a Bearer token in the Authorization header: Authorization: Bearer <YOUR_API_KEY>.

Path Parameters

id
string
required

The subscription ID.

Response

OK (no secret).

id
string

Subscription ID. Required for GET / PUT / DELETE.

Example:

"6a27a76692d9e3a8ffd7e62d"

organization_id
string

Owning organization (resolved from your API key).

Example:

"ddd6f1d8-b232-497e-bf1e-ea7317622d17"

scope
enum<string>

Resolved delivery scope.

Available options:
ORGANIZATION,
WORKSPACE,
AGENT
Example:

"ORGANIZATION"

created_user_id
string

User that created the subscription.

Example:

"google-oauth2|101090478854418701727"

name
string
Example:

"Payment Events Webhook"

url
string
Example:

"https://api.example.com/webhooks/payments"

events
string[]
Example:
active
boolean
Example:

true

headers
Headers · object

Custom HTTP headers forwarded with each delivery; omitted when unset.

Example:
description
string

Free-text description; omitted when unset.

Example:

"Receives payment events with custom authentication"

agent_ids
string[]

Agent scope; omitted when unset.

workspace_ids
string[]

Workspace scope; omitted when unset.

request_timeout_ms
integer

Per-attempt delivery timeout in ms (default 1000).

Example:

1000

retry_policy
WebhookRetryPolicy · object

Delivery retry configuration.

signing_enabled
boolean

Whether the subscription has a signing secret. Always present.

Example:

true

secret
string

HMAC signing secret, prefixed whsec_. Present only at issuance when signing is enabled. Never returned by read endpoints.

Example:

"whsec_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"

created_at
string<date-time>
Example:

"2026-06-09T10:15:00.000Z"

updated_at
string<date-time>
Example:

"2026-06-09T10:15:00.000Z"