diff --git a/Home.md b/Home.md index 93a012c..0b2273d 100644 --- a/Home.md +++ b/Home.md @@ -1,21 +1,36 @@ -# Deploy the Project on CamelX Platform +# WhatsApp -Deploy on CamelX Platform in three steps +Send messages to WhatsApp. -## 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 | `whatsapp` | +| Support Level | Stable | +| Labels | cloud,api,chat | +| 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-whatsapp + 4.10.2 + +``` -## Step 3: Expose -Enable **"Expose"** +## Endpoint Properties -Choose an **API Gateway** (Internal, Public, etc.) +| Name | Type | Required | Default | Description | +|------|------|----------|---------|-------------| +| `phoneNumberId` | string | ✓ | | The phone number ID taken from whatsapp-business dashboard. | +| `lazyStartProducer` | boolean | | `false` | Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel's routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing. | +| `apiVersion` | string | | | Facebook graph api version. | +| `baseUri` | string | | | Can be used to set an alternative base URI, e.g. when you want to test the component against a mock WhatsApp API | +| `httpClient` | object | | | HttpClient implementation | +| `webhookPath` | string | | `webhook` | Webhook path | +| `webhookVerifyToken` | string | | | Webhook verify token | +| `whatsappService` | object | | | WhatsApp service implementation | +| `authorizationToken` | string | ✓ | | The authorization access token taken from whatsapp-business dashboard. |