Skip to main content
Version: Current

WebhookError

@rotorsoft/act-root

@rotorsoft/act-root / act-http/src/webhook / WebhookError

Class: WebhookError

Defined in: libs/act-http/src/webhook/types.ts:167

Webhook-specific subclass of RetryableHttpError. Thrown by the webhook helper on 5xx responses, network failures, and timeouts. Existing instanceof WebhookError checks continue to work; new code targeting the generic HTTP integration shape can catch RetryableHttpError instead and handle webhook + custom integrations uniformly.

Extends​

Constructors​

Constructor​

new WebhookError(message, init): WebhookError

Defined in: libs/act-http/src/webhook/types.ts:168

Parameters​

message​

string

init​

HttpDeliveryErrorInit

Returns​

WebhookError

Overrides​

RetryableHttpError.constructor

Properties​

cause?​

optional cause?: unknown

Defined in: node_modules/.pnpm/typescript@6.0.3/node_modules/typescript/lib/lib.es2022.error.d.ts:24

Inherited from​

RetryableHttpError.cause

message​

message: string

Defined in: node_modules/.pnpm/typescript@6.0.3/node_modules/typescript/lib/lib.es5.d.ts:1075

Inherited from​

RetryableHttpError.message

name​

name: string

Defined in: node_modules/.pnpm/typescript@6.0.3/node_modules/typescript/lib/lib.es5.d.ts:1074

Inherited from​

RetryableHttpError.name

responseBody?​

readonly optional responseBody?: string

Defined in: libs/act-http/src/webhook/types.ts:123

Inherited from​

RetryableHttpError.responseBody

stack?​

optional stack?: string

Defined in: node_modules/.pnpm/typescript@6.0.3/node_modules/typescript/lib/lib.es5.d.ts:1076

Inherited from​

RetryableHttpError.stack

status​

readonly status: number

Defined in: libs/act-http/src/webhook/types.ts:121

Inherited from​

RetryableHttpError.status

url​

readonly url: string

Defined in: libs/act-http/src/webhook/types.ts:122

Inherited from​

RetryableHttpError.url

stackTraceLimit​

static stackTraceLimit: number

Defined in: node_modules/.pnpm/@types+node@22.20.5/node_modules/@types/node/globals.d.ts:68

The Error.stackTraceLimit property specifies the number of stack frames collected by a stack trace (whether generated by new Error().stack or Error.captureStackTrace(obj)).

The default value is 10 but may be set to any valid JavaScript number. Changes will affect any stack trace captured after the value has been changed.

If set to a non-number value, or set to a negative number, stack traces will not capture any frames.

Inherited from​

RetryableHttpError.stackTraceLimit

Methods​

captureStackTrace()​

static captureStackTrace(targetObject, constructorOpt?): void

Defined in: node_modules/.pnpm/@types+node@22.20.5/node_modules/@types/node/globals.d.ts:52

Creates a .stack property on targetObject, which when accessed returns a string representing the location in the code at which Error.captureStackTrace() was called.

const myObject = {};
Error.captureStackTrace(myObject);
myObject.stack;  // Similar to `new Error().stack`

The first line of the trace will be prefixed with ${myObject.name}: ${myObject.message}.

The optional constructorOpt argument accepts a function. If given, all frames above constructorOpt, including constructorOpt, will be omitted from the generated stack trace.

The constructorOpt argument is useful for hiding implementation details of error generation from the user. For instance:

function a() {
  b();
}

function b() {
  c();
}

function c() {
  // Create an error without stack trace to avoid calculating the stack trace twice.
  const { stackTraceLimit } = Error;
  Error.stackTraceLimit = 0;
  const error = new Error();
  Error.stackTraceLimit = stackTraceLimit;

  // Capture the stack trace above function b
  Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
  throw error;
}

a();

Parameters​

targetObject​

object

constructorOpt?​

Function

Returns​

void

Inherited from​

RetryableHttpError.captureStackTrace

prepareStackTrace()​

static prepareStackTrace(err, stackTraces): any

Defined in: node_modules/.pnpm/@types+node@22.20.5/node_modules/@types/node/globals.d.ts:56

Parameters​

err​

Error

stackTraces​

CallSite[]

Returns​

any

See​

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

Inherited from​

RetryableHttpError.prepareStackTrace