agents / Exports / WebhookPlugin

Class: WebhookPlugin

Webhook Plugin using Facade Pattern Provides a clean interface for webhook functionality

Hierarchy

• AbstractPlugin<WebhookPluginOptions, WebhookPluginStats>

  ↳ WebhookPlugin

Table of contents

Constructors

• constructor

Properties

• enabled
• category
• priority
• name
• version

Methods

• initialize
• subscribeToModuleEvents
• unsubscribeFromModuleEvents
• dispose
• enable
• disable
• isEnabled
• getConfig
• updateConfig
• getData
• clearData
• getStatus
• beforeRun
• afterRun
• beforeExecution
• beforeConversation
• beforeToolCall
• beforeToolExecution
• afterToolCall
• beforeProviderCall
• afterProviderCall
• onStreamingChunk
• onMessageAdded
• onModuleEvent
• afterExecution
• afterConversation
• afterToolExecution
• onError
• sendWebhook
• sendCustomWebhook
• getStats
• clearQueue
• destroy

Constructors

constructor

• new WebhookPlugin(options): WebhookPlugin

Parameters

Name	Type
options	WebhookPluginOptions

Returns

WebhookPlugin

Overrides

AbstractPlugin.constructor

Defined in

packages/agents/src/plugins/webhook/webhook-plugin.ts:66

Properties

enabled

• enabled: boolean = true

Plugin enabled state

Inherited from

AbstractPlugin.enabled

Defined in

packages/agents/src/abstracts/abstract-plugin.ts:307

---

category

• category: PluginCategory = PluginCategory.CUSTOM

Plugin category for classification

Inherited from

AbstractPlugin.category

Defined in

packages/agents/src/abstracts/abstract-plugin.ts:310

---

priority

• priority: number = PluginPriority.NORMAL

Plugin priority for execution order

Inherited from

AbstractPlugin.priority

Defined in

packages/agents/src/abstracts/abstract-plugin.ts:313

---

name

• name: string = 'WebhookPlugin'

Plugin name

Overrides

AbstractPlugin.name

Defined in

packages/agents/src/plugins/webhook/webhook-plugin.ts:55

---

version

• version: string = '1.0.0'

Plugin version

Overrides

AbstractPlugin.version

Defined in

packages/agents/src/plugins/webhook/webhook-plugin.ts:56

Methods

initialize

▸ initialize(options?): Promise<void>

Initialize the plugin with type-safe options

Parameters

Name	Type
options?	WebhookPluginOptions

Returns

Promise<void>

Inherited from

AbstractPlugin.initialize

Defined in

packages/agents/src/abstracts/abstract-plugin.ts:338

---

subscribeToModuleEvents

▸ subscribeToModuleEvents(eventEmitter): Promise<void>

Subscribe to module events through EventEmitter

Parameters

Name	Type
eventEmitter	EventEmitterPlugin

Returns

Promise<void>

Inherited from

AbstractPlugin.subscribeToModuleEvents

Defined in

packages/agents/src/abstracts/abstract-plugin.ts:366

---

unsubscribeFromModuleEvents

▸ unsubscribeFromModuleEvents(eventEmitter): Promise<void>

Unsubscribe from module events

Parameters

Name	Type
eventEmitter	EventEmitterPlugin

Returns

Promise<void>

Inherited from

AbstractPlugin.unsubscribeFromModuleEvents

Defined in

packages/agents/src/abstracts/abstract-plugin.ts:423

---

dispose

▸ dispose(): Promise<void>

Cleanup plugin resources

Returns

Promise<void>

Inherited from

AbstractPlugin.dispose

Defined in

packages/agents/src/abstracts/abstract-plugin.ts:438

---

enable

▸ enable(): void

Enable the plugin

Returns

void

Inherited from

AbstractPlugin.enable

Defined in

packages/agents/src/abstracts/abstract-plugin.ts:450

---

disable

▸ disable(): void

Disable the plugin

Returns

void

Inherited from

AbstractPlugin.disable

Defined in

packages/agents/src/abstracts/abstract-plugin.ts:457

---

isEnabled

▸ isEnabled(): boolean

Check if plugin is enabled

Returns

boolean

Inherited from

AbstractPlugin.isEnabled

Defined in

packages/agents/src/abstracts/abstract-plugin.ts:464

---

getConfig

▸ getConfig(): IPluginConfig

Get plugin configuration

Returns

IPluginConfig

Inherited from

AbstractPlugin.getConfig

Defined in

packages/agents/src/abstracts/abstract-plugin.ts:471

---

updateConfig

▸ updateConfig(_config): void

Update plugin configuration

Parameters

Name	Type
_config	IPluginConfig

Returns

void

Inherited from

AbstractPlugin.updateConfig

Defined in

packages/agents/src/abstracts/abstract-plugin.ts:478

---

getData

▸ getData(): IPluginData

Get plugin data - enhanced with classification information

Returns

IPluginData

Inherited from

AbstractPlugin.getData

Defined in

packages/agents/src/abstracts/abstract-plugin.ts:485

---

clearData

▸ clearData(): void

Clear plugin data - common interface for all plugins This method should be implemented by plugins that store data

Returns

void

Inherited from

AbstractPlugin.clearData

Defined in

packages/agents/src/abstracts/abstract-plugin.ts:505

---

getStatus

▸ getStatus(): Object

Get plugin status - enhanced with classification information

Returns

Object

Name	Type
name	string
version	string
enabled	boolean
initialized	boolean
category	PluginCategory
priority	number
subscribedEventsCount	number
hasEventEmitter	boolean

Inherited from

AbstractPlugin.getStatus

Defined in

packages/agents/src/abstracts/abstract-plugin.ts:510

---

beforeRun

▸ beforeRun(input, options?): Promise<void>

Called before agent run

Parameters

Name	Type
input	string
options?	IRunOptions

Returns

Promise<void>

Inherited from

AbstractPlugin.beforeRun

Defined in

packages/agents/src/abstracts/abstract-plugin.ts:564

---

afterRun

▸ afterRun(input, response, options?): Promise<void>

Called after agent run

Parameters

Name	Type
input	string
response	string
options?	IRunOptions

Returns

Promise<void>

Inherited from

AbstractPlugin.afterRun

Defined in

packages/agents/src/abstracts/abstract-plugin.ts:565

---

beforeExecution

▸ beforeExecution(context): Promise<void>

Called before execution with context

Parameters

Name	Type
context	IPluginExecutionContext

Returns

Promise<void>

Inherited from

AbstractPlugin.beforeExecution

Defined in

packages/agents/src/abstracts/abstract-plugin.ts:566

---

beforeConversation

▸ beforeConversation(context): Promise<void>

Called before conversation with context

Parameters

Name	Type
context	IPluginExecutionContext

Returns

Promise<void>

Inherited from

AbstractPlugin.beforeConversation

Defined in

packages/agents/src/abstracts/abstract-plugin.ts:568

---

beforeToolCall

▸ beforeToolCall(toolName, parameters): Promise<void>

Called before tool execution

Parameters

Name	Type
toolName	string
parameters	TToolParameters

Returns

Promise<void>

Inherited from

AbstractPlugin.beforeToolCall

Defined in

packages/agents/src/abstracts/abstract-plugin.ts:570

---

beforeToolExecution

▸ beforeToolExecution(context, toolData): Promise<void>

Called before tool execution with context

Parameters

Name	Type
context	IPluginExecutionContext
toolData	IToolExecutionContext

Returns

Promise<void>

Inherited from

AbstractPlugin.beforeToolExecution

Defined in

packages/agents/src/abstracts/abstract-plugin.ts:571

---

afterToolCall

▸ afterToolCall(toolName, parameters, result): Promise<void>

Called after tool execution

Parameters

Name	Type
toolName	string
parameters	TToolParameters
result	IToolExecutionResult

Returns

Promise<void>

Inherited from

AbstractPlugin.afterToolCall

Defined in

packages/agents/src/abstracts/abstract-plugin.ts:572

---

beforeProviderCall

▸ beforeProviderCall(messages): Promise<void>

Called before AI provider call

Parameters

Name	Type
messages	TUniversalMessage[]

Returns

Promise<void>

Inherited from

AbstractPlugin.beforeProviderCall

Defined in

packages/agents/src/abstracts/abstract-plugin.ts:574

---

afterProviderCall

▸ afterProviderCall(messages, response): Promise<void>

Called after AI provider call

Parameters

Name	Type
messages	TUniversalMessage[]
response	TUniversalMessage

Returns

Promise<void>

Inherited from

AbstractPlugin.afterProviderCall

Defined in

packages/agents/src/abstracts/abstract-plugin.ts:575

---

onStreamingChunk

▸ onStreamingChunk(chunk): Promise<void>

Called on streaming chunk

Parameters

Name	Type
chunk	TUniversalMessage

Returns

Promise<void>

Inherited from

AbstractPlugin.onStreamingChunk

Defined in

packages/agents/src/abstracts/abstract-plugin.ts:576

---

onMessageAdded

▸ onMessageAdded(message): Promise<void>

Called on message added to history

Parameters

Name	Type
message	TUniversalMessage

Returns

Promise<void>

Inherited from

AbstractPlugin.onMessageAdded

Defined in

packages/agents/src/abstracts/abstract-plugin.ts:578

---

onModuleEvent

▸ onModuleEvent(eventType, eventData): Promise<void>

Called when module events are received

Parameters

Name	Type
eventType	EventType
eventData	EventData

Returns

Promise<void>

Inherited from

AbstractPlugin.onModuleEvent

Defined in

packages/agents/src/abstracts/abstract-plugin.ts:579

---

afterExecution

▸ afterExecution(context, result): Promise<void>

After execution completes

Parameters

Name	Type
context	IPluginExecutionContext
result	IPluginExecutionResult

Returns

Promise<void>

Overrides

AbstractPlugin.afterExecution

Defined in

packages/agents/src/plugins/webhook/webhook-plugin.ts:119

---

afterConversation

▸ afterConversation(context, result): Promise<void>

After conversation completes

Parameters

Name	Type
context	IPluginExecutionContext
result	IPluginExecutionResult

Returns

Promise<void>

Overrides

AbstractPlugin.afterConversation

Defined in

packages/agents/src/plugins/webhook/webhook-plugin.ts:130

---

afterToolExecution

▸ afterToolExecution(context, toolResults): Promise<void>

After tool execution

REASON: Tool results structure varies by tool type and provider, needs flexible handling for webhook processing ALTERNATIVES_CONSIDERED:

1. Strict tool result interfaces (breaks tool compatibility)
2. Union types (insufficient for dynamic tool results)
3. Generic constraints (too complex for webhook processing)
4. Interface definitions (too rigid for varied tool results)
5. Type assertions (decreases type safety) TODO: Consider standardized tool result interface across tools

Parameters

Name	Type
context	IPluginExecutionContext
toolResults	IPluginExecutionResult

Returns

Promise<void>

Overrides

AbstractPlugin.afterToolExecution

Defined in

packages/agents/src/plugins/webhook/webhook-plugin.ts:150

---

onError

▸ onError(error, context?): Promise<void>

On error

Parameters

Name	Type
error	Error
context?	IPluginErrorContext

Returns

Promise<void>

Overrides

AbstractPlugin.onError

Defined in

packages/agents/src/plugins/webhook/webhook-plugin.ts:171

---

sendWebhook

▸ sendWebhook(event, data, metadata?): Promise<void>

Send webhook notification

Parameters

Name	Type
event	WebhookEventType
data	WebhookEventData
metadata?	WebhookMetadata

Returns

Promise<void>

Defined in

packages/agents/src/plugins/webhook/webhook-plugin.ts:191

---

sendCustomWebhook

▸ sendCustomWebhook(data, metadata?): Promise<void>

Send custom webhook

Parameters

Name	Type
data	WebhookEventData
metadata?	WebhookMetadata

Returns

Promise<void>

Defined in

packages/agents/src/plugins/webhook/webhook-plugin.ts:232

---

getStats

▸ getStats(): WebhookPluginStats

Get webhook plugin statistics

Returns

WebhookPluginStats

Overrides

AbstractPlugin.getStats

Defined in

packages/agents/src/plugins/webhook/webhook-plugin.ts:357

---

clearQueue

▸ clearQueue(): void

Clear webhook queue

Returns

void

Defined in

packages/agents/src/plugins/webhook/webhook-plugin.ts:375

---

destroy

▸ destroy(): Promise<void>

Cleanup on plugin destruction

Returns

Promise<void>

Defined in

packages/agents/src/plugins/webhook/webhook-plugin.ts:384