Class default

Lightweight webhook dispatcher that posts JSON payloads to configured URLs.

Index

Constructors

Methods

Constructors

constructor

new default(
endpointsByEvent?: EndpointsByEvent,
options?: WebHookDispatcherOptions,
): default
Parameters
- endpointsByEvent: EndpointsByEvent = {}
- options: WebHookDispatcherOptions = {}
Returns default
- Defined in util/webhooks.ts:44

Methods

trigger

trigger(
    eventName: string,
    payload: unknown,
    headers?: HeadersRecord,
): Promise<WebHookDispatchResult>
Trigger a webhook event and POST the payload to all configured URLs.
Parameters
- eventName: string
  The webhook event identifier.
- payload: unknown
  Payload to serialise as JSON.
- headers: HeadersRecord = {}
  Additional HTTP headers for the request.
Returns Promise<WebHookDispatchResult>
- Defined in util/webhooks.ts:75