GET /service/api/notifications/subscriptions/{subscriptionId}
Gets information about a specific subscription.
Request Information
URI Parameters
Name | Description | Type | Additional Information |
---|---|---|---|
subscriptionId |
The identifier of the subscription to retrieve. |
string |
Required |
URI Sample(s)
GET
|
https://unityapi.webrootcloudav.com/service/api/notifications/subscriptions/a05564cb-362b-4753-8d41-f98835cc718f
|
Body Parameters
None.
Response Information
Resource Description
Information about a specific subscription with information on the subscribed domain and event types.
GetSubscriptionResponseModelName | Description | Type | Additional Information |
---|---|---|---|
SubscriptionId |
The subscription identifier. |
string |
None. |
DeliveryType |
The delivery type of the subscription. |
string |
None. |
Domain |
The domain the subscription has been created for. |
SubscriptionResponseModelDomain |
None. |
EventTypes |
The list of subscribed event types. |
Collection of string |
None. |
Webhook |
Information about webhook properties set for the subscription. This value is null, if DeliveryType is anything other than "webhook". |
SubscriptionResponseModelWebhook |
None. |
CreatedDate |
The time when the subscription was created. |
date |
None. |
UpdatedDate |
The time when the subscription was last updated. |
date |
None. |
Sample Response
{ "SubscriptionId": "1047aefe-6079-4909-9a9c-ade432b5437b", "DeliveryType": "fetch", "Domain": { "Type": "Site", "Values": [ { "Name": "GSMKey", "Value": "1AE6-3D5A-27BC-47A5-A7C5" }, { "Name": "SiteKey", "Value": "7698-B7CD-9C46-4E1A-9C8B" } ] }, "EventTypes": [ "Endpoint.FileDetection" ], "Webhook": { "DeliveryContext": "MyCustomCorrelationString", "DeliveryRateInSeconds": 90, "DeliveryUrl": "https://my.company.com/wrunity/notifications/webhook", "Suspended": false, "Statistics": null }, "CreatedDate": "2024-01-27T04:02:56.0200862Z", "UpdatedDate": "2024-02-27T04:02:56.0200862Z" }
<GetSubscriptionResponseModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Webroot.UnityAPI.ServiceExtension.Notifications.Models"> <CreatedDate>2024-01-27T04:02:56.0200862Z</CreatedDate> <DeliveryType>fetch</DeliveryType> <Domain> <Type>Site</Type> <Values> <SubscriptionResponseModelDomainValue> <Name>GSMKey</Name> <Value>1AE6-3D5A-27BC-47A5-A7C5</Value> </SubscriptionResponseModelDomainValue> <SubscriptionResponseModelDomainValue> <Name>SiteKey</Name> <Value>7698-B7CD-9C46-4E1A-9C8B</Value> </SubscriptionResponseModelDomainValue> </Values> </Domain> <EventTypes xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:string>Endpoint.FileDetection</d2p1:string> </EventTypes> <SubscriptionId>1047aefe-6079-4909-9a9c-ade432b5437b</SubscriptionId> <UpdatedDate>2024-02-27T04:02:56.0200862Z</UpdatedDate> <Webhook> <DeliveryContext>MyCustomCorrelationString</DeliveryContext> <DeliveryRateInSeconds>90</DeliveryRateInSeconds> <DeliveryUrl>https://my.company.com/wrunity/notifications/webhook</DeliveryUrl> <Statistics i:nil="true" /> <Suspended>false</Suspended> </Webhook> </GetSubscriptionResponseModel>