generated from camel.apache.org/component
Update wiki Home page for clickup
parent
43f4d2613f
commit
29c9870442
42
Home.md
42
Home.md
@ -1,21 +1,35 @@
|
|||||||
# Deploy the Project on CamelX Platform
|
# ClickUp
|
||||||
|
|
||||||
Deploy on CamelX Platform in three steps
|
Receives events from ClickUp
|
||||||
|
|
||||||
## Step 1: Create a release
|
## Metadata
|
||||||
From the project space, click on **"Create a release"**
|
|
||||||
|
|
||||||
The new version is automatically available in the list
|
| Property | Value |
|
||||||
|
|----------|-------|
|
||||||
|
| Scheme | `clickup` |
|
||||||
|
| Support Level | Preview |
|
||||||
|
| Labels | cloud |
|
||||||
|
| Version | 4.10.2 |
|
||||||
|
|
||||||
## Step 2: Deploy
|
## Maven Dependency
|
||||||
Click on **"Deploy"**
|
|
||||||
|
|
||||||
- **Version:** Select the desired release
|
```xml
|
||||||
- **Environment:** Choose `Development`, `Staging`, or `Production`
|
<dependency>
|
||||||
- **Configuration:** Select the configuration source
|
<groupId>org.apache.camel</groupId>
|
||||||
- **Resources:** Set CPU and Memory
|
<artifactId>camel-clickup</artifactId>
|
||||||
|
<version>4.10.2</version>
|
||||||
|
</dependency>
|
||||||
|
```
|
||||||
|
|
||||||
## Step 3: Expose
|
## Endpoint Properties
|
||||||
Enable **"Expose"**
|
|
||||||
|
|
||||||
Choose an **API Gateway** (Internal, Public, etc.)
|
| Name | Type | Required | Default | Description |
|
||||||
|
|------|------|----------|---------|-------------|
|
||||||
|
| `workspaceId` | integer | ✓ | | The WorkspaceID. |
|
||||||
|
| `events` | string | ✓ | | The comma separated list of events to which the webhook must subscribe |
|
||||||
|
| `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. |
|
||||||
|
| `baseUrl` | string | | | Can be used to set an alternative base URL, e.g. when you want to test the component against a mock ClickUp API |
|
||||||
|
| `authorizationToken` | string | | | The authorization token for authenticating against the ClickUp API. |
|
||||||
|
| `webhookSecret` | string | | | The shared secret obtained in the webhook creation response. |
|
||||||
|
|||||||
Loading…
Reference in New Issue
Block a user