WebhookRuntime
Defined in: packages/webhook/src/runtime/types.ts:125
Methods
Section titled “Methods”addEndpoint()
Section titled “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;secretUndecryptable?:true;status:"error"|"active"|"inactive"|"suspended";updatedAt:Date;url:string; }>
Defined in: packages/webhook/src/runtime/types.ts:126
Parameters
Section titled “Parameters”Returns
Section titled “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; secretUndecryptable?: true; status: "error" | "active" | "inactive" | "suspended"; updatedAt: Date; url: string; }>
addEndpoints()
Section titled “addEndpoints()”addEndpoints(
inputs):Promise<object[]>
Defined in: packages/webhook/src/runtime/types.ts:127
Parameters
Section titled “Parameters”inputs
Section titled “inputs”readonly WebhookEndpointInput[]
Returns
Section titled “Returns”Promise<object[]>
emit()
Section titled “emit()”emit(
event):Promise<void>
Defined in: packages/webhook/src/runtime/types.ts:140
Parameters
Section titled “Parameters”Returns
Section titled “Returns”Promise<void>
emitSync()
Section titled “emitSync()”emitSync(
event):Promise<object[]>
Defined in: packages/webhook/src/runtime/types.ts:141
Parameters
Section titled “Parameters”Returns
Section titled “Returns”Promise<object[]>
flush()
Section titled “flush()”flush():
Promise<void>
Defined in: packages/webhook/src/runtime/types.ts:142
Returns
Section titled “Returns”Promise<void>
getEndpoint()
Section titled “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;secretUndecryptable?:true;status:"error"|"active"|"inactive"|"suspended";updatedAt:Date;url:string; } |null>
Defined in: packages/webhook/src/runtime/types.ts:135
Parameters
Section titled “Parameters”endpointId
Section titled “endpointId”string
Returns
Section titled “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; secretUndecryptable?: true; status: "error" | "active" | "inactive" | "suspended"; updatedAt: Date; url: string; } | null>
listDeliveries()
Section titled “listDeliveries()”listDeliveries(
options?):Promise<object[]>
Defined in: packages/webhook/src/runtime/types.ts:143
Parameters
Section titled “Parameters”options?
Section titled “options?”Returns
Section titled “Returns”Promise<object[]>
listEndpoints()
Section titled “listEndpoints()”listEndpoints():
Promise<object[]>
Defined in: packages/webhook/src/runtime/types.ts:136
Returns
Section titled “Returns”Promise<object[]>
migrateFieldCryptoToTenant()
Section titled “migrateFieldCryptoToTenant()”migrateFieldCryptoToTenant():
Promise<WebhookTenantMigrationResult>
Defined in: packages/webhook/src/runtime/types.ts:152
Re-encrypts stored endpoint secrets and delivery payloads written before
ciphertext was bound to fieldCrypto.tenantId. Run it once every
instance is upgraded; endpoint writes through this runtime wait until it
finishes. See migrateWebhookFieldCryptoToTenant.
Returns
Section titled “Returns”Promise<WebhookTenantMigrationResult>
probeEndpoint()
Section titled “probeEndpoint()”probeEndpoint(
input):Promise<WebhookTestResult>
Defined in: packages/webhook/src/runtime/types.ts:137
Parameters
Section titled “Parameters”string | WebhookRuntimeTestPayload
Returns
Section titled “Returns”Promise<WebhookTestResult>
removeEndpoint()
Section titled “removeEndpoint()”removeEndpoint(
endpointId):Promise<void>
Defined in: packages/webhook/src/runtime/types.ts:134
Parameters
Section titled “Parameters”endpointId
Section titled “endpointId”string
Returns
Section titled “Returns”Promise<void>
shutdown()
Section titled “shutdown()”shutdown():
Promise<void>
Defined in: packages/webhook/src/runtime/types.ts:158
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.
Returns
Section titled “Returns”Promise<void>
updateEndpoint()
Section titled “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;secretUndecryptable?:true;status:"error"|"active"|"inactive"|"suspended";updatedAt:Date;url:string; }>
Defined in: packages/webhook/src/runtime/types.ts:130
Parameters
Section titled “Parameters”endpointId
Section titled “endpointId”string
updates
Section titled “updates”Partial<WebhookEndpointInput>
Returns
Section titled “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; secretUndecryptable?: true; status: "error" | "active" | "inactive" | "suspended"; updatedAt: Date; url: string; }>