Skip to main content
GET
Get subscription

Authorizations

Authorization
string
header
required

Bearer access token issued by Peerlogic.

Path Parameters

id
string
required

A unique value identifying this subscription.

Response

The requested subscription.

name
string
required

Customer-defined name used to identify the subscription.

Required string length: 1 - 128
created_at
string<date-time>
read-only

Time when the subscription was created.

description
string | null

Customer-defined explanation of the workflow this subscription supports.

Maximum string length: 255
destination
string | null
read-only

Delivery destination. Webhook destinations must be HTTPS URLs.

Minimum string length: 1
extra
string | null

Optional customer-defined value available for webhook subscriptions.

Maximum string length: 255
id
string
read-only

Unique subscription ID. Webhook deliveries include this value in X-Subscription-ID.

Minimum string length: 1
is_active
boolean

Whether the subscription is enabled to produce deliveries.

modified_at
string<date-time>
read-only

Time when the subscription was last changed.

practice_id
string
read-only

Practice whose activity is evaluated for this subscription.

subscription_type
enum<string>
read-only

Delivery channel used by the subscription. Customer webhook integrations use webhook.

Available options:
webhook,
email,
sms,
noop
system_message
enum<string> | null
read-only

Current verification or delivery status requiring attention, or null when no status is present.

Available options:
email_verification_required,
phone_verification_required,
disabled_for_consecutive_error_responses,
disabled_for_404_response,
unexpected_response_received
trigger
object
read-only

Condition that produces a delivery for this subscription.