Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Webhook

Class representing the Webhook resource. A Webhook is a HTTP callback: a HTTP request that occurs when something happens; a simple event-notification via the HTTP protocol.

Hierarchy

Index

Constructors

constructor

Properties

Optional _links

_links: Map<string, HalLink>

Optional active

active: boolean

Enables or disables the webhook

Optional customPayload

customPayload: WebhookCustomPayload

A customized payload format.

Optional events

events: string[]

List of events that will cause this webhook to trigger

Optional filters

filters: WebhookFilter[]

List of filters used to gate sending of webhooks.

Optional handlers

handlers: string[]

List of callback URLs to invoke when an event triggers

Optional headers

headers: WebhookHeader[]

List of custom webhook headers to be sent.

Optional id

id: string

Unique id generated on creation

Optional label

label: string

Friendly display label for the Webhook

Optional method

method: "POST" | "PUT" | "PATCH" | "DELETE"

The webhooks HTTP method.

Optional secret

secret: string

When a notification is sent, this value will be used to calculate a cryptographic hash which is transmitted as part of the notification. This hash can be used to assert a trusted party sent the notification.

Methods

parse

  • parse(data: unknown): void

Protected performActionWithoutResourceResponse

  • performActionWithoutResourceResponse(name: string, params: any, data: any, method?: POST | PATCH | PUT): Promise<void>

toJSON

  • toJSON(): any

toJson

  • toJson(): any

Object literals

Readonly related

related: object

Resources and actions related to a Webhook

delete

  • delete(): Promise<void>

hub

  • hub(): Promise<Hub>

update

Generated using TypeDoc