WebhookRuntimeService

Defined in: packages/webhook/src/runtime/webhook-runtime.service.ts:60

Implements

• WebhookRuntime

Constructors

Constructor

new WebhookRuntimeService(config): WebhookRuntimeService

Defined in: packages/webhook/src/runtime/webhook-runtime.service.ts:75

Parameters

config

WebhookRuntimeConfig

Returns

WebhookRuntimeService

Methods

addEndpoint()

addEndpoint(input): Promise<{ active: boolean; createdAt: Date; description?: string; events: WebhookEventType[]; filters?: { channelId?: string[]; providerId?: string[]; templateId?: string[]; }; headers?: Record<string, string>; id: string; lastTriggeredAt?: Date; name?: string; retryConfig?: { backoffMultiplier: number; maxRetries: number; retryDelayMs: number; }; secret?: string; status: "error" | "active" | "inactive" | "suspended"; updatedAt: Date; url: string; }>

Defined in: packages/webhook/src/runtime/webhook-runtime.service.ts:98

Parameters

input

WebhookEndpointInput

Returns

Promise<{ active: boolean; createdAt: Date; description?: string; events: WebhookEventType[]; filters?: { channelId?: string[]; providerId?: string[]; templateId?: string[]; }; headers?: Record<string, string>; id: string; lastTriggeredAt?: Date; name?: string; retryConfig?: { backoffMultiplier: number; maxRetries: number; retryDelayMs: number; }; secret?: string; status: "error" | "active" | "inactive" | "suspended"; updatedAt: Date; url: string; }>

Implementation of

WebhookRuntime.addEndpoint

---

addEndpoints()

addEndpoints(inputs): Promise<object[]>

Defined in: packages/webhook/src/runtime/webhook-runtime.service.ts:120

Parameters

inputs

readonly WebhookEndpointInput[]

Returns

Promise<object[]>

Implementation of

WebhookRuntime.addEndpoints

---

emit()

emit(event): Promise<void>

Defined in: packages/webhook/src/runtime/webhook-runtime.service.ts:223

Parameters

event

WebhookEvent

Returns

Promise<void>

Implementation of

WebhookRuntime.emit

---

emitSync()

emitSync(event): Promise<object[]>

Defined in: packages/webhook/src/runtime/webhook-runtime.service.ts:238

Parameters

event

WebhookEvent

Returns

Promise<object[]>

Implementation of

WebhookRuntime.emitSync

---

flush()

flush(): Promise<void>

Defined in: packages/webhook/src/runtime/webhook-runtime.service.ts:260

Returns

Promise<void>

Implementation of

WebhookRuntime.flush

---

getEndpoint()

getEndpoint(endpointId): Promise<{ active: boolean; createdAt: Date; description?: string; events: WebhookEventType[]; filters?: { channelId?: string[]; providerId?: string[]; templateId?: string[]; }; headers?: Record<string, string>; id: string; lastTriggeredAt?: Date; name?: string; retryConfig?: { backoffMultiplier: number; maxRetries: number; retryDelayMs: number; }; secret?: string; status: "error" | "active" | "inactive" | "suspended"; updatedAt: Date; url: string; } | null>

Defined in: packages/webhook/src/runtime/webhook-runtime.service.ts:172

Parameters

endpointId

string

Returns

Promise<{ active: boolean; createdAt: Date; description?: string; events: WebhookEventType[]; filters?: { channelId?: string[]; providerId?: string[]; templateId?: string[]; }; headers?: Record<string, string>; id: string; lastTriggeredAt?: Date; name?: string; retryConfig?: { backoffMultiplier: number; maxRetries: number; retryDelayMs: number; }; secret?: string; status: "error" | "active" | "inactive" | "suspended"; updatedAt: Date; url: string; } | null>

Implementation of

WebhookRuntime.getEndpoint

---

listDeliveries()

listDeliveries(options?): Promise<object[]>

Defined in: packages/webhook/src/runtime/webhook-runtime.service.ts:268

Parameters

options?

WebhookDeliveryListOptions = {}

Returns

Promise<object[]>

Implementation of

WebhookRuntime.listDeliveries

---

listEndpoints()

listEndpoints(): Promise<object[]>

Defined in: packages/webhook/src/runtime/webhook-runtime.service.ts:177

Returns

Promise<object[]>

Implementation of

WebhookRuntime.listEndpoints

---

probeEndpoint()

probeEndpoint(input): Promise<WebhookTestResult>

Defined in: packages/webhook/src/runtime/webhook-runtime.service.ts:182

Parameters

input

string | WebhookRuntimeTestPayload

Returns

Promise<WebhookTestResult>

Implementation of

WebhookRuntime.probeEndpoint

---

removeEndpoint()

removeEndpoint(endpointId): Promise<void>

Defined in: packages/webhook/src/runtime/webhook-runtime.service.ts:167

Parameters

endpointId

string

Returns

Promise<void>

Implementation of

WebhookRuntime.removeEndpoint

---

shutdown()

shutdown(): Promise<void>

Defined in: packages/webhook/src/runtime/webhook-runtime.service.ts:278

Returns

Promise<void>

Implementation of

WebhookRuntime.shutdown

---

updateEndpoint()

updateEndpoint(endpointId, updates): Promise<{ active: boolean; createdAt: Date; description?: string; events: WebhookEventType[]; filters?: { channelId?: string[]; providerId?: string[]; templateId?: string[]; }; headers?: Record<string, string>; id: string; lastTriggeredAt?: Date; name?: string; retryConfig?: { backoffMultiplier: number; maxRetries: number; retryDelayMs: number; }; secret?: string; status: "error" | "active" | "inactive" | "suspended"; updatedAt: Date; url: string; }>

Defined in: packages/webhook/src/runtime/webhook-runtime.service.ts:131

Parameters

endpointId

string

updates

Partial<WebhookEndpointInput>

Returns

Promise<{ active: boolean; createdAt: Date; description?: string; events: WebhookEventType[]; filters?: { channelId?: string[]; providerId?: string[]; templateId?: string[]; }; headers?: Record<string, string>; id: string; lastTriggeredAt?: Date; name?: string; retryConfig?: { backoffMultiplier: number; maxRetries: number; retryDelayMs: number; }; secret?: string; status: "error" | "active" | "inactive" | "suspended"; updatedAt: Date; url: string; }>

Implementation of

WebhookRuntime.updateEndpoint