diff --git a/Home.md b/Home.md index 93a012c..019391c 100644 --- a/Home.md +++ b/Home.md @@ -1,21 +1,29 @@ -# Deploy the Project on CamelX Platform +# Webhook Source -Deploy on CamelX Platform in three steps +Creates an HTTP endpoint that can be used as a bridge to forward data to the Kamelet sink. -## Step 1: Create a release -From the project space, click on **"Create a release"** +The "subpath" parameter of the Webhook source allows to customize the subpath where the integration will respond to HTTP requests. +It's common to use a non-guessable ID for that parameter. -The new version is automatically available in the list +When the "subpath" parameter is set to "webhook" (default), the integration will accept requests at the "https://integration-external-url/webhook" endpoint. -## Step 2: Deploy -Click on **"Deploy"** +## Metadata -- **Version:** Select the desired release -- **Environment:** Choose `Development`, `Staging`, or `Production` -- **Configuration:** Select the configuration source -- **Resources:** Set CPU and Memory +| Property | Value | +|----------|-------| +| Type | source | +| Group | Webhook | +| Namespace | Cloud | +| Support Level | Stable | +| Provider | Apache Software Foundation | -## Step 3: Expose -Enable **"Expose"** +## Properties -Choose an **API Gateway** (Internal, Public, etc.) +| Name | Type | Required | Default | Description | +|------|------|----------|---------|-------------| +| `subpath` | string | | `webhook` | The subpath where the webhook is registered | + +## Dependencies + +- `camel:platform-http` +- `camel:kamelet`