Skip to content

Get Subscription

GET
/platform/v1/webhooks/subscriptions/{sub_id}
curl --request GET \
--url https://example.com/platform/v1/webhooks/subscriptions/1

Get one subscription. 404 opaque on cross-account.

sub_id
required
Sub Id
integer

Successful Response

Media type application/json
PlatformWebhookSubscriptionResponse

Subscription response — NEVER includes secret_encrypted.

object
buffer_max_batch
Any of:
integer
buffer_window_seconds
Any of:
integer
created_at
Any of:
string format: date-time
custom_headers
Any of:
object
key
additional properties
string
description
Any of:
string
developer_account_id
required
Developer Account Id
integer
event_types
Event Types
Array<string>
failure_count
required
Failure Count
integer
id
required
Id
integer
inactivity_minutes
Any of:
integer
is_active
required
Is Active
boolean
is_paused
required
Is Paused
boolean
last_delivery_at
Any of:
string format: date-time
paused_reason
Any of:
string
platform_channel_id
Any of:
integer
target_url
required
Target Url
string
updated_at
Any of:
string format: date-time
Example generated
{
"buffer_max_batch": 1,
"buffer_window_seconds": 1,
"created_at": "2026-04-15T12:00:00Z",
"custom_headers": {
"additionalProperty": "example"
},
"description": "example",
"developer_account_id": 1,
"event_types": [
"example"
],
"failure_count": 1,
"id": 1,
"inactivity_minutes": 1,
"is_active": true,
"is_paused": true,
"last_delivery_at": "2026-04-15T12:00:00Z",
"paused_reason": "example",
"platform_channel_id": 1,
"target_url": "example",
"updated_at": "2026-04-15T12:00:00Z"
}

Validation Error

Media type application/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
ctx
Context
object
input
Input
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
Example generated
{
"detail": [
{
"ctx": {},
"input": "example",
"loc": [
"example"
],
"msg": "example",
"type": "example"
}
]
}