Documentation

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/a6c12733-7dac-4fd7-b9a3-c1ad159e0ad4

Body Parameters

None.

Response Information

Resource Description

Information about a specific subscription with information on the subscribed domain and event types.

GetSubscriptionResponseModel

Name	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": "c27ea715-5277-41f0-9ca5-58a80e9a0f17",
  "DeliveryType": "fetch",
  "Domain": {
    "Type": "Site",
    "Values": [
      {
        "Name": "GSMKey",
        "Value": "3BAB-E750-D32E-4E74-8A89"
      },
      {
        "Name": "SiteKey",
        "Value": "951F-EA4C-678E-4EA5-8CB5"
      }
    ]
  },
  "EventTypes": [
    "Endpoint.FileDetection"
  ],
  "Webhook": {
    "DeliveryContext": "MyCustomCorrelationString",
    "DeliveryRateInSeconds": 90,
    "DeliveryUrl": "https://my.company.com/wrunity/notifications/webhook",
    "Suspended": false,
    "Statistics": null
  },
  "CreatedDate": "2024-11-22T08:47:40.7478117Z",
  "UpdatedDate": "2024-12-22T08:47:40.7478117Z"
}

<GetSubscriptionResponseModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Webroot.UnityAPI.ServiceExtension.Notifications.Models">
  <CreatedDate>2024-11-22T08:47:40.7478117Z</CreatedDate>
  <DeliveryType>fetch</DeliveryType>
  <Domain>
    <Type>Site</Type>
    <Values>
      <SubscriptionResponseModelDomainValue>
        <Name>GSMKey</Name>
        <Value>3BAB-E750-D32E-4E74-8A89</Value>
      </SubscriptionResponseModelDomainValue>
      <SubscriptionResponseModelDomainValue>
        <Name>SiteKey</Name>
        <Value>951F-EA4C-678E-4EA5-8CB5</Value>
      </SubscriptionResponseModelDomainValue>
    </Values>
  </Domain>
  <EventTypes xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>Endpoint.FileDetection</d2p1:string>
  </EventTypes>
  <SubscriptionId>c27ea715-5277-41f0-9ca5-58a80e9a0f17</SubscriptionId>
  <UpdatedDate>2024-12-22T08:47:40.7478117Z</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>