Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update webhook docs #1471

Merged
merged 4 commits into from
Apr 10, 2024
Merged

Update webhook docs #1471

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
66c0d6b
docs: Add webhook batching and update retry
EnriqueL8 Jul 12, 2023
57b1233
fix: fix broken links
SamMayWork Feb 22, 2024
3ccd032
Merge remote-tracking branch 'origin/main' into update_webhook_docs
EnriqueL8 Apr 9, 2024
ad8a6f5
fix: make reference
EnriqueL8 Apr 9, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 15 additions & 2 deletions docs/reference/types/_includes/subscription_description.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -169,8 +169,8 @@ allowing you to customize your HTTP requests as follows:
- Method, URL, query, headers and input body
- Wait for a invocation of the back-end service, before acknowledging
- To retry requests to your Webhook on a non-`2xx` HTTP status code
or other error, then you should enable and configure
[events.webhooks.retry](../../config.html#eventswebhooksretry)
or other error, you should enable and configure
[options.retry](../subscription.html#webhookretryoptions)
- The event is acknowledged once the request (with any retries), is
completed - regardless of whether the outcome was a success or failure.
- Use `fastack` to acknowledge against FireFly immediately and make multiple
Expand All @@ -186,3 +186,16 @@ allowing you to customize your HTTP requests as follows:
based on a field in the input request data.


#### Batching events

Webhooks have the ability to batch events into a single HTTP request instead of sending an event per HTTP request. The interface will be a JSON array of events instead of a top level JSON object with a single event. The size of the batch will be set by the `readAhead` limit and an optional timeout can be specified to send the events when the batch hasn't filled.

To enable this set the following configuration under [SubscriptionOptions](../subscription.html#subscriptionoptions)

`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. Defaults to 2 seconds | `string`


**NOTE**: When batch is enabled, `withData` cannot be used as these may alter the HTTP request based on a single event and in batching it does not make sense for now.

Loading