The Guild LogoThe Guild Monogram

Search docs

Search icon

Products by The Guild

Products

Hive logoHive blurred logo

Hive

Schema Registry for your GraphQL Workflows

Skip to main content

Interface: WebhookHandler

types/src.YamlConfig.WebhookHandler

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:133


path#

path: string

Path that remote API will ping

Defined in#

packages/types/src/config.ts:129


payload#

Optional payload: string

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

Defined in#

packages/types/src/config.ts:141


pubsubTopic#

pubsubTopic: string

Name of the topic you want to pass incoming payload

Defined in#

packages/types/src/config.ts:137