Merge pull request #1359 from kaleido-io/batching_webhooks

feat: batching events and webhook plugin support

Author: EnriqueL8

docs/reference/types/subscription.md

@@ -105,6 +105,8 @@ nav_order: 3
 | `firstEvent` | Whether your application would like to receive events from the 'oldest' event emitted by your FireFly node (from the beginning of time), or the 'newest' event (from now), or a specific event sequence. Default is 'newest' | `SubOptsFirstEvent` |
 | `readAhead` | The number of events to stream ahead to your application, while waiting for confirmation of consumption of those events. At least once delivery semantics are used in FireFly, so if your application crashes/reconnects this is the maximum number of events you would expect to be redelivered after it restarts | `uint16` |
 | `withData` | Whether message events delivered over the subscription, should be packaged with the full data of those messages in-line as part of the event JSON payload. Or if the application should make separate REST calls to download that data. May not be supported on some transports. | `bool` |
+| `batch` | Events are delivered in batches in an ordered array. The batch size is capped to the readAhead limit. The event payload is always an array even if there is a single event in the batch. Commonly used with Webhooks to allow events to be delivered and acknowledged in batches. | `bool` |
+| `batchTimeout` | When batching is enabled, the optional timeout to send events even when the batch hasn't filled. | `string` |
 | `fastack` | Webhooks only: When true the event will be acknowledged before the webhook is invoked, allowing parallel invocations | `bool` |
 | `url` | Webhooks only: HTTP url to invoke. Can be relative if a base URL is set in the webhook plugin config | `string` |
 | `method` | Webhooks only: HTTP method to invoke. Default=POST | `string` |
@@ -148,7 +150,7 @@ nav_order: 3
 | `requestTimeout` | The max duration to hold a TLS handshake alive | `string` |
 | `maxIdleConns` | The max number of idle connections to hold pooled | `int` |
 | `idleTimeout` | The max duration to hold a HTTP keepalive connection between calls | `string` |
-| `connectionTimeout` |  | `string` |
+| `connectionTimeout` | The maximum amount of time that a connection is allowed to remain with no data transmitted. | `string` |
 | `expectContinueTimeout` | See [ExpectContinueTimeout in the Go docs](https://pkg.go.dev/net/http#Transport) | `string` |
 
 

docs/reference/types/wsstart.md

@@ -96,6 +96,8 @@ nav_order: 23
 | `firstEvent` | Whether your application would like to receive events from the 'oldest' event emitted by your FireFly node (from the beginning of time), or the 'newest' event (from now), or a specific event sequence. Default is 'newest' | `SubOptsFirstEvent` |
 | `readAhead` | The number of events to stream ahead to your application, while waiting for confirmation of consumption of those events. At least once delivery semantics are used in FireFly, so if your application crashes/reconnects this is the maximum number of events you would expect to be redelivered after it restarts | `uint16` |
 | `withData` | Whether message events delivered over the subscription, should be packaged with the full data of those messages in-line as part of the event JSON payload. Or if the application should make separate REST calls to download that data. May not be supported on some transports. | `bool` |
+| `batch` | Events are delivered in batches in an ordered array. The batch size is capped to the readAhead limit. The event payload is always an array even if there is a single event in the batch. Commonly used with Webhooks to allow events to be delivered and acknowledged in batches. | `bool` |
+| `batchTimeout` | When batching is enabled, the optional timeout to send events even when the batch hasn't filled. | `string` |
 | `fastack` | Webhooks only: When true the event will be acknowledged before the webhook is invoked, allowing parallel invocations | `bool` |
 | `url` | Webhooks only: HTTP url to invoke. Can be relative if a base URL is set in the webhook plugin config | `string` |
 | `method` | Webhooks only: HTTP method to invoke. Default=POST | `string` |
@@ -139,7 +141,7 @@ nav_order: 23
 | `requestTimeout` | The max duration to hold a TLS handshake alive | `string` |
 | `maxIdleConns` | The max number of idle connections to hold pooled | `int` |
 | `idleTimeout` | The max duration to hold a HTTP keepalive connection between calls | `string` |
-| `connectionTimeout` |  | `string` |
+| `connectionTimeout` | The maximum amount of time that a connection is allowed to remain with no data transmitted. | `string` |
 | `expectContinueTimeout` | See [ExpectContinueTimeout in the Go docs](https://pkg.go.dev/net/http#Transport) | `string` |