Interface ICreateWebhookParams

Parameters when creating a webhook.

interface ICreateWebhookParams {
    callbackUrl: string;
    filter?: string;
    hookAttribute?: object;
    scope: WebhookScope;
}

Properties

callbackUrl: string

Callback URL registered for the webhook.

filter?: string

JsonPath expression (for example, "$[?(@.ext=='txt')]") that can be used to filter the callbacks you receive.

hookAttribute?: object

A user-defined JSON object, which you can use to store/set some custom information. The maximum size of the JSON object (content) should be less than 1KB.

An object that represents the extent to where the event is monitored. For example, if the scope is folder, the webhooks service generates a notification for the specified event occurring in any sub folder or item within that folder.

Generated using TypeDoc