Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IUpdateWebhookParams

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

Hierarchy

  • IUpdateWebhookParams

Index

Properties

Optional filter

filter: undefined | null | string

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

Optional hookAttribute

hookAttribute: undefined | 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.

Optional status

status: undefined | Active | Inactive

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

Generated using TypeDoc