From b6beec92fa0f2cfdb335c166feee35c241246902 Mon Sep 17 00:00:00 2001 From: gitea_admin Date: Wed, 11 Mar 2026 14:43:03 +0000 Subject: [PATCH] Update wiki Home page for webhook --- Home.md | 43 +++++++++++++++++++++++++++++-------------- 1 file changed, 29 insertions(+), 14 deletions(-) diff --git a/Home.md b/Home.md index 93a012c..add926e 100644 --- a/Home.md +++ b/Home.md @@ -1,21 +1,36 @@ -# Deploy the Project on CamelX Platform +# Webhook -Deploy on CamelX Platform in three steps +Expose webhook endpoints to receive push notifications for other Camel components. -## Step 1: Create a release -From the project space, click on **"Create a release"** +## Metadata -The new version is automatically available in the list +| Property | Value | +|----------|-------| +| Scheme | `webhook` | +| Support Level | Stable | +| Labels | cloud | +| Version | 4.10.2 | -## Step 2: Deploy -Click on **"Deploy"** +## Maven Dependency -- **Version:** Select the desired release -- **Environment:** Choose `Development`, `Staging`, or `Production` -- **Configuration:** Select the configuration source -- **Resources:** Set CPU and Memory +```xml + + org.apache.camel + camel-webhook + 4.10.2 + +``` -## Step 3: Expose -Enable **"Expose"** +## Endpoint Properties -Choose an **API Gateway** (Internal, Public, etc.) +| Name | Type | Required | Default | Description | +|------|------|----------|---------|-------------| +| `endpointUri` | string | ✓ | | The delegate uri. Must belong to a component that supports webhooks. | +| `webhookAutoRegister` | boolean | | `true` | Automatically register the webhook at startup and unregister it on shutdown. | +| `webhookBasePath` | string | | | The first (base) path element where the webhook will be exposed. It's a good practice to set it to a random string, so that it cannot be guessed by unauthorized parties. | +| `webhookComponentName` | string | | | The Camel Rest component to use for the REST transport, such as netty-http. | +| `webhookExternalUrl` | string | | | The URL of the current service as seen by the webhook provider | +| `webhookPath` | string | | | The path where the webhook endpoint will be exposed (relative to basePath, if any) | +| `bridgeErrorHandler` | boolean | | `false` | Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions, that will be logged at WARN or ERROR level and ignored. | +| `exceptionHandler` | object | | | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this option is not in use. By default the consumer will deal with exceptions, that will be logged at WARN or ERROR level and ignored. | +| `exchangePattern` | object | | | Sets the exchange pattern when the consumer creates an exchange. |