GET /service/api/notifications/subscriptions/{subscriptionId}

Gets information about a specific subscription.

Request Information

URI Parameters

NameDescriptionTypeAdditional Information
subscriptionId

The identifier of the subscription to retrieve.

string

Required

URI Sample(s)

GET
https://unityapi.webrootcloudav.com/service/api/notifications/subscriptions/4f664a84-c628-4bb0-9539-81299b3d4386

Body Parameters

None.

Response Information

Resource Description

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

GetSubscriptionResponseModel
NameDescriptionTypeAdditional 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": "7d835026-fb27-44d8-8b08-119ef945742f",
  "DeliveryType": "fetch",
  "Domain": {
    "Type": "Site",
    "Values": [
      {
        "Name": "GSMKey",
        "Value": "1BCA-35E9-E12C-4E64-9B23"
      },
      {
        "Name": "SiteKey",
        "Value": "3BC2-9309-09AD-4B87-9D0C"
      }
    ]
  },
  "EventTypes": [
    "Endpoint.FileDetection"
  ],
  "Webhook": {
    "DeliveryContext": "MyCustomCorrelationString",
    "DeliveryRateInSeconds": 90,
    "DeliveryUrl": "https://my.company.com/wrunity/notifications/webhook",
    "Suspended": false,
    "Statistics": null
  },
  "CreatedDate": "2022-11-09T05:02:01.7404116Z",
  "UpdatedDate": "2022-12-09T05:02:01.7404116Z"
}                    
<GetSubscriptionResponseModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Webroot.UnityAPI.ServiceExtension.Notifications.Models">
  <CreatedDate>2022-11-09T05:02:01.7404116Z</CreatedDate>
  <DeliveryType>fetch</DeliveryType>
  <Domain>
    <Type>Site</Type>
    <Values>
      <SubscriptionResponseModelDomainValue>
        <Name>GSMKey</Name>
        <Value>1BCA-35E9-E12C-4E64-9B23</Value>
      </SubscriptionResponseModelDomainValue>
      <SubscriptionResponseModelDomainValue>
        <Name>SiteKey</Name>
        <Value>3BC2-9309-09AD-4B87-9D0C</Value>
      </SubscriptionResponseModelDomainValue>
    </Values>
  </Domain>
  <EventTypes xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>Endpoint.FileDetection</d2p1:string>
  </EventTypes>
  <SubscriptionId>7d835026-fb27-44d8-8b08-119ef945742f</SubscriptionId>
  <UpdatedDate>2022-12-09T05:02:01.7404116Z</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>