WebhookRuntime

Defined in: packages/webhook/src/runtime/types.ts:73

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/types.ts:74

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; }>

---

addEndpoints()

addEndpoints(inputs): Promise<object[]>

Defined in: packages/webhook/src/runtime/types.ts:75

Parameters

inputs

readonly WebhookEndpointInput[]

Returns

Promise<object[]>

---

emit()

emit(event): Promise<void>

Defined in: packages/webhook/src/runtime/types.ts:88

Parameters

event

WebhookEvent

Returns

Promise<void>

---

emitSync()

emitSync(event): Promise<object[]>

Defined in: packages/webhook/src/runtime/types.ts:89

Parameters

event

WebhookEvent

Returns

Promise<object[]>

---

flush()

flush(): Promise<void>

Defined in: packages/webhook/src/runtime/types.ts:90

Returns

Promise<void>

---

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

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>

---

listDeliveries()

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

Defined in: packages/webhook/src/runtime/types.ts:91

Parameters

options?

WebhookDeliveryListOptions

Returns

Promise<object[]>

---

listEndpoints()

listEndpoints(): Promise<object[]>

Defined in: packages/webhook/src/runtime/types.ts:84

Returns

Promise<object[]>

---

probeEndpoint()

probeEndpoint(input): Promise<WebhookTestResult>

Defined in: packages/webhook/src/runtime/types.ts:85

Parameters

input

string | WebhookRuntimeTestPayload

Returns

Promise<WebhookTestResult>

---

removeEndpoint()

removeEndpoint(endpointId): Promise<void>

Defined in: packages/webhook/src/runtime/types.ts:82

Parameters

endpointId

string

Returns

Promise<void>

---

shutdown()

shutdown(): Promise<void>

Defined in: packages/webhook/src/runtime/types.ts:94

Returns

Promise<void>

---

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

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; }>