WebhookEndpointStore
Defined in: packages/webhook/src/runtime/types.ts:30
Stores webhook endpoints. Ids and URLs are unique: a store never replaces one endpoint with another, so a re-registered URL cannot silently get a new id and secret.
Methods
Section titled “Methods”add(
endpoint):Promise<void>
Defined in: packages/webhook/src/runtime/types.ts:35
Stores a new endpoint. Rejects with WebhookEndpointConflictError when
an endpoint with the same id or URL is already stored.
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 = ...
secretUndecryptable?
Section titled “secretUndecryptable?”true = ...
status
Section titled “status”"error" | "active" | "inactive" | "suspended" = ...
updatedAt
Section titled “updatedAt”Date = ...
string = ...
Returns
Section titled “Returns”Promise<void>
get(
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/runtime/types.ts:43
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; secretUndecryptable?: true; status: "error" | "active" | "inactive" | "suspended"; updatedAt: Date; url: string; } | null>
list()
Section titled “list()”list():
Promise<object[]>
Defined in: packages/webhook/src/runtime/types.ts:44
Returns
Section titled “Returns”Promise<object[]>
remove()
Section titled “remove()”remove(
endpointId):Promise<void>
Defined in: packages/webhook/src/runtime/types.ts:42
Parameters
Section titled “Parameters”endpointId
Section titled “endpointId”string
Returns
Section titled “Returns”Promise<void>
update()
Section titled “update()”update(
endpointId,endpoint):Promise<void>
Defined in: packages/webhook/src/runtime/types.ts:41
Replaces the endpoint stored under endpointId. Rejects when there is
none, and with WebhookEndpointConflictError when another endpoint has
the new URL.
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 = ...
secretUndecryptable?
Section titled “secretUndecryptable?”true = ...
status
Section titled “status”"error" | "active" | "inactive" | "suspended" = ...
updatedAt
Section titled “updatedAt”Date = ...
string = ...
Returns
Section titled “Returns”Promise<void>