EditSubscriptionRequestModelWebhook

Specifies new or updated properties for webhook-based subscriptions.

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.

Note: When changing this value, the webhook DeliveryUrl will be called with a Type value of "Validation". For the edit subscription request to succeed, the webhook has to respond successfully with the ValidationResponse set to the ValidationContext value provided in the webhook call. See the related webhook section in the Notifications Guide for more information.

(If specifying a new DeliveryUrl as part of the same edit subscription request, the new one will be called for validation. Otherwise the DeliveryUrl of the original subscription will be called.)

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. For example, when specifying 300 seconds, Unity API will at least wait 300 seconds before calling the webhook of new notifications again. Set to 0 if the webhook should be called as soon as possible when new notifications become available.

integer

Must be 0 or a number between 5 and 3600. Default value is 60.

DeliveryUrl

The URL of a publicly accessible API function (the webhook) which should be called by Unity API to confirm the webhook subscription and to inform about the availability of new notifications (must be an HTTPS endpoint with a fully qualified domain name and a valid certificate).

Note: When changing this value, the provided web address will be called with a Type value of "Validation". For the edit subscription request to succeed, the webhook has to respond successfully with the ValidationResponse set to the ValidationContext value provided in the webhook call. See the related webhook section in the Notifications Guide for more information.

URI

Required (when changing from a non-webhook to a webhook-based subscription)