Docs
API
Interfaces
WebhookPluginConfig

Interface: WebhookPluginConfig

types/src.YamlConfig.WebhookPluginConfig

Webhook plugin

Table of contents

Properties

Properties

method

Optional method: "GET" | "POST" | "DELETE" | "PATCH"

HTTP Method that the handler will control (Allowed values: GET, POST, DELETE, PATCH)

Defined in

packages/types/src/config.ts:2001


path

path: string

Path that remote API will ping

Defined in

packages/types/src/config.ts:1997


payload

Optional payload: string

Part of the object you want to pass (e.g. data.messages)

Defined in

packages/types/src/config.ts:2009


pubsubTopic

pubsubTopic: string

Name of the topic you want to pass incoming payload

Defined in

packages/types/src/config.ts:2005