agents / Exports / WebhookPluginOptions
Interface: WebhookPluginOptions
Webhook plugin configuration options
Hierarchy
↳
WebhookPluginOptions
Table of contents
Properties
- enabled
- category
- priority
- moduleEvents
- subscribeToAllModuleEvents
- endpoints
- events
- defaultTimeout
- defaultRetries
- async
- maxConcurrency
- batching
- payloadTransformer
Properties
enabled
• Optional enabled: boolean
Whether the plugin is enabled
Inherited from
Defined in
packages/agents/src/abstracts/base-plugin.ts:125
category
• Optional category: PluginCategory
Plugin category for classification
Inherited from
Defined in
packages/agents/src/abstracts/base-plugin.ts:127
priority
• Optional priority: number
Plugin priority for execution order
Inherited from
Defined in
packages/agents/src/abstracts/base-plugin.ts:129
moduleEvents
• Optional moduleEvents: EventType[]
Events to subscribe to from modules
Inherited from
BasePluginOptions.moduleEvents
Defined in
packages/agents/src/abstracts/base-plugin.ts:131
subscribeToAllModuleEvents
• Optional subscribeToAllModuleEvents: boolean
Whether to subscribe to all module events
Inherited from
BasePluginOptions.subscribeToAllModuleEvents
Defined in
packages/agents/src/abstracts/base-plugin.ts:133
endpoints
• endpoints: WebhookEndpoint[]
Webhook endpoints
Defined in
packages/agents/src/plugins/webhook/types.ts:163
events
• Optional events: WebhookEventType[]
Events to send webhooks for
Defined in
packages/agents/src/plugins/webhook/types.ts:165
defaultTimeout
• Optional defaultTimeout: number
Default timeout for webhook requests
Defined in
packages/agents/src/plugins/webhook/types.ts:167
defaultRetries
• Optional defaultRetries: number
Default retry attempts
Defined in
packages/agents/src/plugins/webhook/types.ts:169
async
• Optional async: boolean
Whether to use async sending
Defined in
packages/agents/src/plugins/webhook/types.ts:171
maxConcurrency
• Optional maxConcurrency: number
Maximum concurrent webhook requests
Defined in
packages/agents/src/plugins/webhook/types.ts:173
batching
• Optional batching: Object
Whether to batch webhook requests
Type declaration
| Name | Type |
|---|---|
enabled | boolean |
maxSize | number |
flushInterval | number |
Defined in
packages/agents/src/plugins/webhook/types.ts:175
payloadTransformer
• Optional payloadTransformer: (event: WebhookEventType, data: WebhookEventData) => WebhookEventData
Custom payload transformer
Type declaration
▸ (event, data): WebhookEventData
Parameters
| Name | Type |
|---|---|
event | WebhookEventType |
data | WebhookEventData |
Returns
WebhookEventData