NameDescriptionTypeAdditional information
AppId

The AppId for the receiving application.

string

Data type: Text

Valid name with max 256 characters

Name

A name for the subscription.

string

Required

Min length: 1

Valid name with max 256 characters

Uri

The uri to the receiving application.

string

Required

Max length: 2083

DefaultHeaders

Default headers that are required by the receiving application. Leave empty if no extra headers are required.

Dictionary of string [key] and Collection of string [value]

None.

IsActive

Determines if the subscription is in use or not.

boolean

None.

WebHookSubscriptionPackageNames

Selected webhook packages names determining witch events to subscribe on.

Collection of string

None.

Secret

The key for the receiving application. Use as a shared secret.

string

Data type: Text

Valid name with max 256 characters

BatchWebhooks

Determines if the webhooks should be sent in batches

boolean

None.

BatchSize

The amount of webhooks to be sent in each batch

string

None.