Get Webhook Subscription
https://qa.api.wealthcare.com/notifications/1.1/subscriptions/webhooks/{subscriptionId}
Get the details of a specific subscription. The response includes the subscription's configuration, status, and other details.
Required Scopes:
notifications_subscriptions_read
Request
-
subscriptionId string <uuid> Required
The unique identifier for the subscription.
Response
-
subscriptionId string <uuid>
The unique identifier for the subscription.
-
name string
The name of the subscription.
Min Length: 5 Max Length: 50 -
administratorId string
The TPA Id or owner of the events to be sent to the webhook.
Min Length: 3 Max Length: 10 -
events object
-
source string
The namespace for the event.
Min Length: 5 Max Length: 50 -
type string
The type of event that triggers the webhook.
Min Length: 5 Max Length: 50
-
-
active boolean
Determines if notifications are sent when the webhook is triggered. Set to true to send notifications.
-
config object
-
url string
The URL to which the payload will be delivered.
Max Length: 4000 -
secretLastUpdateDate string <date-time>
The date the secret was last updated.
-
-
status enum<string>
The status of the subscription.
Possible values:ReadySetupInProgress -
updateDate string <date-time>
The date the subscription was last updated.
-
createdDate string <date-time>
The date the subscription was created.
Response Headers
No response yet.
Response Body
No response yet.