SubscriptionResponseModelWebhook

Provides information about webhook properties set for the subscription.

NameDescriptionTypeAdditional Information
DeliveryContext

A user defined value which can be used for reference purposes in the webhook. This may be useful as an additional context value for lookup purposes in addition to the subscription identifier, and as an added layer of security for verifying the source of the webhook caller.

string

None.

DeliveryRateInSeconds

The time interval for callouts made to the webhook, i.e. the time which will at least pass between two webhook “Notifications” callouts for a given subscription. If 300, for example, Unity API will at least wait 300 seconds before calling the webhook of new notifications again. If 0, the webhook is called as soon as possible when new notifications become available.

integer

None.

DeliveryUrl

The URL of the publicly accessible API function (the webhook) which is called by Unity API to inform about the availability of new notifications.

URI

None.

Suspended

Value indicating whether calls to the webhook DeliveryUrl were suspended due to too many consecutive failures or in case the Suspend webhook API was called for the subscription.

boolean

None.

Statistics

Provides operational information about the calls to the webhook DeliveryUrl.

SubscriptionResponseModelWebhookStatistics

None.