콘텐츠로 이동

WebhookRuntimeService

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

new WebhookRuntimeService(config): WebhookRuntimeService

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

WebhookRuntimeConfig

WebhookRuntimeService

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; secretUndecryptable?: true; status: "error" | "active" | "inactive" | "suspended"; updatedAt: Date; url: string; }>

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

WebhookEndpointInput

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; secretUndecryptable?: true; status: "error" | "active" | "inactive" | "suspended"; updatedAt: Date; url: string; }>

WebhookRuntime.addEndpoint


addEndpoints(inputs): Promise<object[]>

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

readonly WebhookEndpointInput[]

Promise<object[]>

WebhookRuntime.addEndpoints


emit(event): Promise<void>

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

WebhookEvent

Promise<void>

WebhookRuntime.emit


emitSync(event): Promise<object[]>

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

WebhookEvent

Promise<object[]>

WebhookRuntime.emitSync


flush(): Promise<void>

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

Promise<void>

WebhookRuntime.flush


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; secretUndecryptable?: true; status: "error" | "active" | "inactive" | "suspended"; updatedAt: Date; url: string; } | null>

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

string

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; secretUndecryptable?: true; status: "error" | "active" | "inactive" | "suspended"; updatedAt: Date; url: string; } | null>

WebhookRuntime.getEndpoint


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

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

WebhookDeliveryListOptions = {}

Promise<object[]>

WebhookRuntime.listDeliveries


listEndpoints(): Promise<object[]>

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

Promise<object[]>

WebhookRuntime.listEndpoints


migrateFieldCryptoToTenant(): Promise<WebhookTenantMigrationResult>

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

Re-encrypts stored endpoint secrets and delivery payloads written before ciphertext was bound to fieldCrypto.tenantId, returning how many of each it rewrote. Run it once every instance is upgraded, then remove fieldCrypto.acceptLegacyAad if it was set to keep them readable in the meantime. Endpoint writes through this runtime wait until it finishes. See migrateWebhookFieldCryptoToTenant.

Promise<WebhookTenantMigrationResult>

WebhookRuntime.migrateFieldCryptoToTenant


probeEndpoint(input): Promise<WebhookTestResult>

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

string | WebhookRuntimeTestPayload

Promise<WebhookTestResult>

WebhookRuntime.probeEndpoint


removeEndpoint(endpointId): Promise<void>

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

string

Promise<void>

WebhookRuntime.removeEndpoint


shutdown(): Promise<void>

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

Stops the batch timer, delivers the queued events, waits for endpoint writes already queued, and closes the persistence. Endpoint changes requested after it starts are rejected.

Promise<void>

WebhookRuntime.shutdown


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; secretUndecryptable?: true; status: "error" | "active" | "inactive" | "suspended"; updatedAt: Date; url: string; }>

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

string

Partial<WebhookEndpointInput>

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; secretUndecryptable?: true; status: "error" | "active" | "inactive" | "suspended"; updatedAt: Date; url: string; }>

WebhookRuntime.updateEndpoint