WebhookRegistry

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

Constructors

Constructor

new WebhookRegistry(options?): WebhookRegistry

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

Parameters

options?

WebhookRegistryOptions = {}

Returns

WebhookRegistry

Methods

addDelivery()

addDelivery(delivery): Promise<void>

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

Parameters

delivery

attempts

object[] = ...

completedAt?

Date = ...

createdAt

Date = ...

endpointId

string = ...

eventId

string = ...

eventType?

MESSAGE_SENT | MESSAGE_DELIVERED | MESSAGE_FAILED | MESSAGE_CLICKED | MESSAGE_READ | MESSAGE_CANCELLED | MESSAGE_UNKNOWN | 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:36

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 = ...

secretUndecryptable?

true = ...

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:88

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

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

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; secretUndecryptable?: true; 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:124

Parameters

endpointId?

string

eventType?

WebhookEventType

Returns

Promise<object[]>

---

listEndpoints()

listEndpoints(): Promise<object[]>

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

Returns

Promise<object[]>

---

removeEndpoint()

removeEndpoint(endpointId): Promise<void>

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

Parameters

endpointId

string

Returns

Promise<void>

---

updateEndpoint()

updateEndpoint(endpointId, endpoint): Promise<void>

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

Replaces the endpoint. With endpoint field crypto, an endpoint without a secret of its own keeps the stored secret, for example one read while it could not be decrypted; set secret, even to undefined, to replace or remove it. A secret that cannot be encrypted in open mode is kept if it is the stored one, and fails the update if the stored one cannot be read to tell.

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 = ...

secretUndecryptable?

true = ...

status

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

updatedAt

Date = ...

url

string = ...

Returns

Promise<void>