WebhookRegistry
Defined in: packages/webhook/src/services/webhook.registry.ts:142
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new WebhookRegistry(
options?):WebhookRegistry
Defined in: packages/webhook/src/services/webhook.registry.ts:147
Parameters
Section titled “Parameters”options?
Section titled “options?”Returns
Section titled “Returns”WebhookRegistry
Methods
Section titled “Methods”addDelivery()
Section titled “addDelivery()”addDelivery(
delivery):Promise<void>
Defined in: packages/webhook/src/services/webhook.registry.ts:184
Parameters
Section titled “Parameters”delivery
Section titled “delivery”attempts
Section titled “attempts”object[] = ...
completedAt?
Section titled “completedAt?”Date = ...
createdAt
Section titled “createdAt”Date = ...
endpointId
Section titled “endpointId”string = ...
eventId
Section titled “eventId”string = ...
eventType?
Section titled “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
Section titled “headers”Record<string, string> = ...
httpMethod
Section titled “httpMethod”"POST" | "PUT" | "PATCH" = ...
string = ...
nextRetryAt?
Section titled “nextRetryAt?”Date = ...
payload
Section titled “payload”string = ...
status
Section titled “status”"failed" | "success" | "pending" | "exhausted" = ...
string = ...
Returns
Section titled “Returns”Promise<void>
addEndpoint()
Section titled “addEndpoint()”addEndpoint(
endpoint):Promise<void>
Defined in: packages/webhook/src/services/webhook.registry.ts:152
Parameters
Section titled “Parameters”endpoint
Section titled “endpoint”active
Section titled “active”boolean = ...
createdAt
Section titled “createdAt”Date = ...
description?
Section titled “description?”string = ...
events
Section titled “events”WebhookEventType[] = ...
filters?
Section titled “filters?”{ channelId?: string[]; providerId?: string[]; templateId?: string[]; } = ...
filters.channelId?
Section titled “filters.channelId?”string[] = ...
filters.providerId?
Section titled “filters.providerId?”string[] = ...
filters.templateId?
Section titled “filters.templateId?”string[] = ...
headers?
Section titled “headers?”Record<string, string> = ...
string = ...
lastTriggeredAt?
Section titled “lastTriggeredAt?”Date = ...
string = ...
retryConfig?
Section titled “retryConfig?”{ backoffMultiplier: number; maxRetries: number; retryDelayMs: number; } = ...
retryConfig.backoffMultiplier
Section titled “retryConfig.backoffMultiplier”number = ...
retryConfig.maxRetries
Section titled “retryConfig.maxRetries”number = ...
retryConfig.retryDelayMs
Section titled “retryConfig.retryDelayMs”number = ...
secret?
Section titled “secret?”string = ...
status
Section titled “status”"error" | "active" | "inactive" | "suspended" = ...
updatedAt
Section titled “updatedAt”Date = ...
string = ...
Returns
Section titled “Returns”Promise<void>
getDeliveries()
Section titled “getDeliveries()”getDeliveries(
endpointId?,timeRange?,eventType?,status?,limit?):Promise<object[]>
Defined in: packages/webhook/src/services/webhook.registry.ts:188
Parameters
Section titled “Parameters”endpointId?
Section titled “endpointId?”string
timeRange?
Section titled “timeRange?”Date
Date
eventType?
Section titled “eventType?”status?
Section titled “status?”string
limit?
Section titled “limit?”number = 100
Returns
Section titled “Returns”Promise<object[]>
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/services/webhook.registry.ts:170
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>
getFailedDeliveries()
Section titled “getFailedDeliveries()”getFailedDeliveries(
endpointId?,eventType?):Promise<object[]>
Defined in: packages/webhook/src/services/webhook.registry.ts:224
Parameters
Section titled “Parameters”endpointId?
Section titled “endpointId?”string
eventType?
Section titled “eventType?”Returns
Section titled “Returns”Promise<object[]>
listEndpoints()
Section titled “listEndpoints()”listEndpoints():
Promise<object[]>
Defined in: packages/webhook/src/services/webhook.registry.ts:176
Returns
Section titled “Returns”Promise<object[]>
removeEndpoint()
Section titled “removeEndpoint()”removeEndpoint(
endpointId):Promise<void>
Defined in: packages/webhook/src/services/webhook.registry.ts:166
Parameters
Section titled “Parameters”endpointId
Section titled “endpointId”string
Returns
Section titled “Returns”Promise<void>
updateEndpoint()
Section titled “updateEndpoint()”updateEndpoint(
endpointId,endpoint):Promise<void>
Defined in: packages/webhook/src/services/webhook.registry.ts:156
Parameters
Section titled “Parameters”endpointId
Section titled “endpointId”string
endpoint
Section titled “endpoint”active
Section titled “active”boolean = ...
createdAt
Section titled “createdAt”Date = ...
description?
Section titled “description?”string = ...
events
Section titled “events”WebhookEventType[] = ...
filters?
Section titled “filters?”{ channelId?: string[]; providerId?: string[]; templateId?: string[]; } = ...
filters.channelId?
Section titled “filters.channelId?”string[] = ...
filters.providerId?
Section titled “filters.providerId?”string[] = ...
filters.templateId?
Section titled “filters.templateId?”string[] = ...
headers?
Section titled “headers?”Record<string, string> = ...
string = ...
lastTriggeredAt?
Section titled “lastTriggeredAt?”Date = ...
string = ...
retryConfig?
Section titled “retryConfig?”{ backoffMultiplier: number; maxRetries: number; retryDelayMs: number; } = ...
retryConfig.backoffMultiplier
Section titled “retryConfig.backoffMultiplier”number = ...
retryConfig.maxRetries
Section titled “retryConfig.maxRetries”number = ...
retryConfig.retryDelayMs
Section titled “retryConfig.retryDelayMs”number = ...
secret?
Section titled “secret?”string = ...
status
Section titled “status”"error" | "active" | "inactive" | "suspended" = ...
updatedAt
Section titled “updatedAt”Date = ...
string = ...
Returns
Section titled “Returns”Promise<void>