EndpointManager
Defined in: packages/webhook/src/registry/endpoint.manager.ts:20
Extends
Section titled “Extends”EventEmitter
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new EndpointManager(
config?):EndpointManager
Defined in: packages/webhook/src/registry/endpoint.manager.ts:32
Parameters
Section titled “Parameters”config?
Section titled “config?”Partial<StorageConfig> = {}
Returns
Section titled “Returns”EndpointManager
Overrides
Section titled “Overrides”EventEmitter.constructor
Methods
Section titled “Methods”addEndpoint()
Section titled “addEndpoint()”addEndpoint(
endpoint):Promise<void>
Defined in: packages/webhook/src/registry/endpoint.manager.ts:48
엔드포인트 추가
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>
addListener()
Section titled “addListener()”addListener(
eventName,listener):this
Defined in: packages/webhook/src/shared/event-emitter.ts:16
Parameters
Section titled “Parameters”eventName
Section titled “eventName”string
listener
Section titled “listener”Listener
Returns
Section titled “Returns”this
Inherited from
Section titled “Inherited from”EventEmitter.addListener
cleanupExpiredEndpoints()
Section titled “cleanupExpiredEndpoints()”cleanupExpiredEndpoints():
Promise<number>
Defined in: packages/webhook/src/registry/endpoint.manager.ts:292
만료된 엔드포인트 정리
Returns
Section titled “Returns”Promise<number>
emit()
Section titled “emit()”emit(
eventName, …args):boolean
Defined in: packages/webhook/src/shared/event-emitter.ts:44
Parameters
Section titled “Parameters”eventName
Section titled “eventName”string
…unknown[]
Returns
Section titled “Returns”boolean
Inherited from
Section titled “Inherited from”EventEmitter.emit
getActiveEndpointsForEvent()
Section titled “getActiveEndpointsForEvent()”getActiveEndpointsForEvent(
eventType):Promise<object[]>
Defined in: packages/webhook/src/registry/endpoint.manager.ts:244
특정 이벤트 타입을 구독하는 활성 엔드포인트 조회
Parameters
Section titled “Parameters”eventType
Section titled “eventType”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/registry/endpoint.manager.ts:152
엔드포인트 조회
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>
getEndpointByUrl()
Section titled “getEndpointByUrl()”getEndpointByUrl(
url):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/registry/endpoint.manager.ts:159
URL로 엔드포인트 조회
Parameters
Section titled “Parameters”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>
getStats()
Section titled “getStats()”getStats():
object
Defined in: packages/webhook/src/registry/endpoint.manager.ts:260
엔드포인트 통계 조회
Returns
Section titled “Returns”object
activeEndpoints
Section titled “activeEndpoints”activeEndpoints:
number
errorEndpoints
Section titled “errorEndpoints”errorEndpoints:
number
eventSubscriptions
Section titled “eventSubscriptions”eventSubscriptions:
Record<WebhookEventType,number>
inactiveEndpoints
Section titled “inactiveEndpoints”inactiveEndpoints:
number
suspendedEndpoints
Section titled “suspendedEndpoints”suspendedEndpoints:
number
totalEndpoints
Section titled “totalEndpoints”totalEndpoints:
number
off(
eventName,listener):this
Defined in: packages/webhook/src/shared/event-emitter.ts:20
Parameters
Section titled “Parameters”eventName
Section titled “eventName”string
listener
Section titled “listener”Listener
Returns
Section titled “Returns”this
Inherited from
Section titled “Inherited from”EventEmitter.off
on(
eventName,listener):this
Defined in: packages/webhook/src/shared/event-emitter.ts:9
Parameters
Section titled “Parameters”eventName
Section titled “eventName”string
listener
Section titled “listener”Listener
Returns
Section titled “Returns”this
Inherited from
Section titled “Inherited from”EventEmitter.on
once()
Section titled “once()”once(
eventName,listener):this
Defined in: packages/webhook/src/shared/event-emitter.ts:35
Parameters
Section titled “Parameters”eventName
Section titled “eventName”string
listener
Section titled “listener”Listener
Returns
Section titled “Returns”this
Inherited from
Section titled “Inherited from”EventEmitter.once
removeAllListeners()
Section titled “removeAllListeners()”removeAllListeners(
eventName?):this
Defined in: packages/webhook/src/shared/event-emitter.ts:57
Parameters
Section titled “Parameters”eventName?
Section titled “eventName?”string
Returns
Section titled “Returns”this
Inherited from
Section titled “Inherited from”EventEmitter.removeAllListeners
removeEndpoint()
Section titled “removeEndpoint()”removeEndpoint(
endpointId):Promise<boolean>
Defined in: packages/webhook/src/registry/endpoint.manager.ts:130
엔드포인트 제거
Parameters
Section titled “Parameters”endpointId
Section titled “endpointId”string
Returns
Section titled “Returns”Promise<boolean>
removeListener()
Section titled “removeListener()”removeListener(
eventName,listener):this
Defined in: packages/webhook/src/shared/event-emitter.ts:31
Parameters
Section titled “Parameters”eventName
Section titled “eventName”string
listener
Section titled “listener”Listener
Returns
Section titled “Returns”this
Inherited from
Section titled “Inherited from”EventEmitter.removeListener
searchEndpoints()
Section titled “searchEndpoints()”searchEndpoints(
filter?,pagination?):Promise<SearchResult<{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/registry/endpoint.manager.ts:167
필터 조건에 맞는 엔드포인트 검색
Parameters
Section titled “Parameters”filter?
Section titled “filter?”EndpointFilter = {}
pagination?
Section titled “pagination?”PaginationOptions = ...
Returns
Section titled “Returns”Promise<SearchResult<{ 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; }>>
shutdown()
Section titled “shutdown()”shutdown():
Promise<void>
Defined in: packages/webhook/src/registry/endpoint.manager.ts:511
엔드포인트 관리자 종료
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/registry/endpoint.manager.ts:80
엔드포인트 업데이트
Parameters
Section titled “Parameters”endpointId
Section titled “endpointId”string
updates
Section titled “updates”Partial<WebhookEndpoint>
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; }>