WebhookRuntime
Defined in: packages/webhook/src/runtime/types.ts:73
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;status:"error"|"active"|"inactive"|"suspended";updatedAt:Date;url:string; }>
Defined in: packages/webhook/src/runtime/types.ts:74
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; 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:75
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:88
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:89
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:90
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;status:"error"|"active"|"inactive"|"suspended";updatedAt:Date;url:string; } |null>
Defined in: packages/webhook/src/runtime/types.ts:83
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; 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:91
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:84
Returns
Section titled “Returns”Promise<object[]>
probeEndpoint()
Section titled “probeEndpoint()”probeEndpoint(
input):Promise<WebhookTestResult>
Defined in: packages/webhook/src/runtime/types.ts:85
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:82
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:94
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;status:"error"|"active"|"inactive"|"suspended";updatedAt:Date;url:string; }>
Defined in: packages/webhook/src/runtime/types.ts:78
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; status: "error" | "active" | "inactive" | "suspended"; updatedAt: Date; url: string; }>