Interface IUpdateWebhookParams

Parameters when updating a webhook. Undefined properties are ignored, and null values can be used to clear the configuration property of webhook.

interface IUpdateWebhookParams {
    filter?: null | string;
    hookAttribute?: null | object;
    status?: WebhookStatus;
}

Properties

filter?: null | string

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

hookAttribute?: null | 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.

status?: WebhookStatus

Webhook status (can be either 'active' or 'inactive').

Generated using TypeDoc