WebhookRegistry

Defined in: packages/webhook/src/services/webhook.registry.ts:142

Constructors

Constructor

new WebhookRegistry(options?): WebhookRegistry

Defined in: packages/webhook/src/services/webhook.registry.ts:147

Parameters

options?

WebhookRegistryOptions = {}

Returns

WebhookRegistry

Methods

addDelivery()

addDelivery(delivery): Promise<void>

Defined in: packages/webhook/src/services/webhook.registry.ts:184

Parameters

delivery

attempts

object[] = ...

completedAt?

Date = ...

createdAt

Date = ...

endpointId

string = ...

eventId

string = ...

eventType?

MESSAGE_SENT | MESSAGE_DELIVERED | MESSAGE_FAILED | MESSAGE_CLICKED | MESSAGE_READ | TEMPLATE_CREATED | TEMPLATE_APPROVED | TEMPLATE_REJECTED | TEMPLATE_UPDATED | TEMPLATE_DELETED | CHANNEL_CREATED | CHANNEL_VERIFIED | SENDER_NUMBER_ADDED | SENDER_NUMBER_VERIFIED | QUOTA_WARNING | QUOTA_EXCEEDED | PROVIDER_ERROR | SYSTEM_MAINTENANCE | ANOMALY_DETECTED | THRESHOLD_EXCEEDED = ...

headers

Record<string, string> = ...

httpMethod

"POST" | "PUT" | "PATCH" = ...

id

string = ...

nextRetryAt?

Date = ...

payload

string = ...

status

"failed" | "success" | "pending" | "exhausted" = ...

url

string = ...

Returns

Promise<void>

---

addEndpoint()

addEndpoint(endpoint): Promise<void>

Defined in: packages/webhook/src/services/webhook.registry.ts:152

Parameters

endpoint

active

boolean = ...

createdAt

Date = ...

description?

string = ...

events

WebhookEventType[] = ...

filters?

{ channelId?: string[]; providerId?: string[]; templateId?: string[]; } = ...

filters.channelId?

string[] = ...

filters.providerId?

string[] = ...

filters.templateId?

string[] = ...

headers?

Record<string, string> = ...

id

string = ...

lastTriggeredAt?

Date = ...

name?

string = ...

retryConfig?

{ backoffMultiplier: number; maxRetries: number; retryDelayMs: number; } = ...

retryConfig.backoffMultiplier

number = ...

retryConfig.maxRetries

number = ...

retryConfig.retryDelayMs

number = ...

secret?

string = ...

status

"error" | "active" | "inactive" | "suspended" = ...

updatedAt

Date = ...

url

string = ...

Returns

Promise<void>

---

getDeliveries()

getDeliveries(endpointId?, timeRange?, eventType?, status?, limit?): Promise<object[]>

Defined in: packages/webhook/src/services/webhook.registry.ts:188

Parameters

endpointId?

string

timeRange?

end

Date

start

Date

eventType?

WebhookEventType

status?

string

limit?

number = 100

Returns

Promise<object[]>

---

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/services/webhook.registry.ts:170

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>

---

getFailedDeliveries()

getFailedDeliveries(endpointId?, eventType?): Promise<object[]>

Defined in: packages/webhook/src/services/webhook.registry.ts:224

Parameters

endpointId?

string

eventType?

WebhookEventType

Returns

Promise<object[]>

---

listEndpoints()

listEndpoints(): Promise<object[]>

Defined in: packages/webhook/src/services/webhook.registry.ts:176

Returns

Promise<object[]>

---

removeEndpoint()

removeEndpoint(endpointId): Promise<void>

Defined in: packages/webhook/src/services/webhook.registry.ts:166

Parameters

endpointId

string

Returns

Promise<void>

---

updateEndpoint()

updateEndpoint(endpointId, endpoint): Promise<void>

Defined in: packages/webhook/src/services/webhook.registry.ts:156

Parameters

endpointId

string

endpoint

active

boolean = ...

createdAt

Date = ...

description?

string = ...

events

WebhookEventType[] = ...

filters?

{ channelId?: string[]; providerId?: string[]; templateId?: string[]; } = ...

filters.channelId?

string[] = ...

filters.providerId?

string[] = ...

filters.templateId?

string[] = ...

headers?

Record<string, string> = ...

id

string = ...

lastTriggeredAt?

Date = ...

name?

string = ...

retryConfig?

{ backoffMultiplier: number; maxRetries: number; retryDelayMs: number; } = ...

retryConfig.backoffMultiplier

number = ...

retryConfig.maxRetries

number = ...

retryConfig.retryDelayMs

number = ...

secret?

string = ...

status

"error" | "active" | "inactive" | "suspended" = ...

updatedAt

Date = ...

url

string = ...

Returns

Promise<void>