<!--
 ⚠️  AUTO-GENERATED FILE - DO NOT EDIT MANUALLY
 This file is automatically generated by scripts/docs-generator.js
 To make changes, edit the source TypeScript files or update the generator script
-->

[agents](../../) / [Exports](../modules) / WebhookPluginOptions

# Interface: WebhookPluginOptions

Webhook plugin configuration options

## Hierarchy

- [`IPluginOptions`](IPluginOptions)

  ↳ **`WebhookPluginOptions`**

## Table of contents

### Properties

- [enabled](WebhookPluginOptions#enabled)
- [category](WebhookPluginOptions#category)
- [priority](WebhookPluginOptions#priority)
- [moduleEvents](WebhookPluginOptions#moduleevents)
- [subscribeToAllModuleEvents](WebhookPluginOptions#subscribetoallmoduleevents)
- [endpoints](WebhookPluginOptions#endpoints)
- [events](WebhookPluginOptions#events)
- [defaultTimeout](WebhookPluginOptions#defaulttimeout)
- [defaultRetries](WebhookPluginOptions#defaultretries)
- [async](WebhookPluginOptions#async)
- [maxConcurrency](WebhookPluginOptions#maxconcurrency)
- [batching](WebhookPluginOptions#batching)
- [payloadTransformer](WebhookPluginOptions#payloadtransformer)

## Properties

### enabled

• `Optional` **enabled**: `boolean`

Whether the plugin is enabled

#### Inherited from

[IPluginOptions](IPluginOptions).[enabled](IPluginOptions#enabled)

#### Defined in

[packages/agents/src/abstracts/abstract-plugin.ts:126](https://github.com/woojubb/robota/blob/4f4c8a3197e92ddd43d12dc9186b0771983054c9/packages/agents/src/abstracts/abstract-plugin.ts#L126)

---

### category

• `Optional` **category**: [`PluginCategory`](../enums/PluginCategory)

Plugin category for classification

#### Inherited from

[IPluginOptions](IPluginOptions).[category](IPluginOptions#category)

#### Defined in

[packages/agents/src/abstracts/abstract-plugin.ts:128](https://github.com/woojubb/robota/blob/4f4c8a3197e92ddd43d12dc9186b0771983054c9/packages/agents/src/abstracts/abstract-plugin.ts#L128)

---

### priority

• `Optional` **priority**: `number`

Plugin priority for execution order

#### Inherited from

[IPluginOptions](IPluginOptions).[priority](IPluginOptions#priority)

#### Defined in

[packages/agents/src/abstracts/abstract-plugin.ts:130](https://github.com/woojubb/robota/blob/4f4c8a3197e92ddd43d12dc9186b0771983054c9/packages/agents/src/abstracts/abstract-plugin.ts#L130)

---

### moduleEvents

• `Optional` **moduleEvents**: [`EventType`](../modules#eventtype)[]

Events to subscribe to from modules

#### Inherited from

[IPluginOptions](IPluginOptions).[moduleEvents](IPluginOptions#moduleevents)

#### Defined in

[packages/agents/src/abstracts/abstract-plugin.ts:132](https://github.com/woojubb/robota/blob/4f4c8a3197e92ddd43d12dc9186b0771983054c9/packages/agents/src/abstracts/abstract-plugin.ts#L132)

---

### subscribeToAllModuleEvents

• `Optional` **subscribeToAllModuleEvents**: `boolean`

Whether to subscribe to all module events

#### Inherited from

[IPluginOptions](IPluginOptions).[subscribeToAllModuleEvents](IPluginOptions#subscribetoallmoduleevents)

#### Defined in

[packages/agents/src/abstracts/abstract-plugin.ts:134](https://github.com/woojubb/robota/blob/4f4c8a3197e92ddd43d12dc9186b0771983054c9/packages/agents/src/abstracts/abstract-plugin.ts#L134)

---

### endpoints

• **endpoints**: [`WebhookEndpoint`](WebhookEndpoint)[]

Webhook endpoints

#### Defined in

[packages/agents/src/plugins/webhook/types.ts:163](https://github.com/woojubb/robota/blob/4f4c8a3197e92ddd43d12dc9186b0771983054c9/packages/agents/src/plugins/webhook/types.ts#L163)

---

### events

• `Optional` **events**: [`WebhookEventType`](../modules#webhookeventtype)[]

Events to send webhooks for

#### Defined in

[packages/agents/src/plugins/webhook/types.ts:165](https://github.com/woojubb/robota/blob/4f4c8a3197e92ddd43d12dc9186b0771983054c9/packages/agents/src/plugins/webhook/types.ts#L165)

---

### defaultTimeout

• `Optional` **defaultTimeout**: `number`

Default timeout for webhook requests

#### Defined in

[packages/agents/src/plugins/webhook/types.ts:167](https://github.com/woojubb/robota/blob/4f4c8a3197e92ddd43d12dc9186b0771983054c9/packages/agents/src/plugins/webhook/types.ts#L167)

---

### defaultRetries

• `Optional` **defaultRetries**: `number`

Default retry attempts

#### Defined in

[packages/agents/src/plugins/webhook/types.ts:169](https://github.com/woojubb/robota/blob/4f4c8a3197e92ddd43d12dc9186b0771983054c9/packages/agents/src/plugins/webhook/types.ts#L169)

---

### async

• `Optional` **async**: `boolean`

Whether to use async sending

#### Defined in

[packages/agents/src/plugins/webhook/types.ts:171](https://github.com/woojubb/robota/blob/4f4c8a3197e92ddd43d12dc9186b0771983054c9/packages/agents/src/plugins/webhook/types.ts#L171)

---

### maxConcurrency

• `Optional` **maxConcurrency**: `number`

Maximum concurrent webhook requests

#### Defined in

[packages/agents/src/plugins/webhook/types.ts:173](https://github.com/woojubb/robota/blob/4f4c8a3197e92ddd43d12dc9186b0771983054c9/packages/agents/src/plugins/webhook/types.ts#L173)

---

### 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](https://github.com/woojubb/robota/blob/4f4c8a3197e92ddd43d12dc9186b0771983054c9/packages/agents/src/plugins/webhook/types.ts#L175)

---

### payloadTransformer

• `Optional` **payloadTransformer**: (`event`: [`WebhookEventType`](../modules#webhookeventtype), `data`: `WebhookEventData`) => `WebhookEventData`

Custom payload transformer

#### Type declaration

▸ (`event`, `data`): `WebhookEventData`

##### Parameters

| Name    | Type                                              |
| :------ | :------------------------------------------------ |
| `event` | [`WebhookEventType`](../modules#webhookeventtype) |
| `data`  | `WebhookEventData`                                |

##### Returns

`WebhookEventData`

#### Defined in

[packages/agents/src/plugins/webhook/types.ts:181](https://github.com/woojubb/robota/blob/4f4c8a3197e92ddd43d12dc9186b0771983054c9/packages/agents/src/plugins/webhook/types.ts#L181)
