agent-plugin-webhook / Exports / IWebhookPluginOptions
Interface: IWebhookPluginOptions
Webhook plugin configuration options
Hierarchy
IPluginOptions↳
IWebhookPluginOptions
Table of contents
Properties
- enabled
- category
- priority
- moduleEvents
- subscribeToAllModuleEvents
- endpoints
- events
- defaultTimeout
- defaultRetries
- async
- maxConcurrency
- batching
- payloadTransformer
Properties
enabled
• Optional enabled: boolean
Inherited from
IPluginOptions.enabled
Defined in
agent-core/dist/node/index.d.ts:971
category
• Optional category: PluginCategory
Inherited from
IPluginOptions.category
Defined in
agent-core/dist/node/index.d.ts:972
priority
• Optional priority: number
Inherited from
IPluginOptions.priority
Defined in
agent-core/dist/node/index.d.ts:973
moduleEvents
• Optional moduleEvents: TEventName[]
Inherited from
IPluginOptions.moduleEvents
Defined in
agent-core/dist/node/index.d.ts:974
subscribeToAllModuleEvents
• Optional subscribeToAllModuleEvents: boolean
Inherited from
IPluginOptions.subscribeToAllModuleEvents
Defined in
agent-core/dist/node/index.d.ts:975
endpoints
• endpoints: IWebhookEndpoint[]
Webhook endpoints
Defined in
agent-plugin-webhook/src/types.ts:158
events
• Optional events: TWebhookEventName[]
Events to send webhooks for
Defined in
agent-plugin-webhook/src/types.ts:160
defaultTimeout
• Optional defaultTimeout: number
Default timeout for webhook requests
Defined in
agent-plugin-webhook/src/types.ts:162
defaultRetries
• Optional defaultRetries: number
Default retry attempts
Defined in
agent-plugin-webhook/src/types.ts:164
async
• Optional async: boolean
Whether to use async sending
Defined in
agent-plugin-webhook/src/types.ts:166
maxConcurrency
• Optional maxConcurrency: number
Maximum concurrent webhook requests
Defined in
agent-plugin-webhook/src/types.ts:168
batching
• Optional batching: Object
Whether to batch webhook requests
Type declaration
| Name | Type |
|---|---|
enabled | boolean |
maxSize | number |
flushInterval | number |
Defined in
agent-plugin-webhook/src/types.ts:170
payloadTransformer
• Optional payloadTransformer: (event: TWebhookEventName, data: IWebhookEventData) => IWebhookEventData
Custom payload transformer
Type declaration
▸ (event, data): IWebhookEventData
Parameters
| Name | Type |
|---|---|
event | TWebhookEventName |
data | IWebhookEventData |
Returns
IWebhookEventData