Chapter 381. Zendesk Component
Available as of Camel version 2.19
The Zendesk component provides access to all of the zendesk.com APIs accessible using zendesk-java-client. It allows producing messages to manage Zendesk ticket, user, organization, etc.
Maven users will need to add the following dependency to their pom.xml for this component:
<dependency>
<groupId>org.apache.camel</groupId>
<artifactId>camel-zendesk</artifactId>
<version>${camel-version}</version>
</dependency>381.1. Zendesk Options
The Zendesk component supports 3 options, which are listed below.
| Name | Description | Default | Type |
|---|---|---|---|
| configuration (common) | To use the shared configuration | ZendeskConfiguration | |
| zendesk (advanced) | To use a shared Zendesk instance. | Zendesk | |
| resolveProperty Placeholders (advanced) | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | boolean |
The Zendesk endpoint is configured using URI syntax:
zendesk:methodName
with the following path and query parameters:
381.1.1. Path Parameters (1 parameters):
| Name | Description | Default | Type |
|---|---|---|---|
| methodName | Required What operation to use | String |
381.1.2. Query Parameters (10 parameters):
| Name | Description | Default | Type |
|---|---|---|---|
| inBody (common) | Sets the name of a parameter to be passed in the exchange In Body | String | |
| serverUrl (common) | The server URL to connect. | String | |
| bridgeErrorHandler (consumer) | Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions occurred while the consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. 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. | false | boolean |
| exceptionHandler (consumer) | 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. | ExceptionHandler | |
| exchangePattern (consumer) | Sets the exchange pattern when the consumer creates an exchange. | ExchangePattern | |
| synchronous (advanced) | Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported). | false | boolean |
| oauthToken (security) | The OAuth token. | String | |
| password (security) | The password. | String | |
| token (security) | The security token. | String | |
| username (security) | The user name. | String |
381.2. Spring Boot Auto-Configuration
The component supports 9 options, which are listed below.
| Name | Description | Default | Type |
|---|---|---|---|
| camel.component.zendesk.configuration.method-name | What operation to use | String | |
| camel.component.zendesk.configuration.oauth-token | The OAuth token. | String | |
| camel.component.zendesk.configuration.password | The password. | String | |
| camel.component.zendesk.configuration.server-url | The server URL to connect. | String | |
| camel.component.zendesk.configuration.token | The security token. | String | |
| camel.component.zendesk.configuration.username | The user name. | String | |
| camel.component.zendesk.enabled | Enable zendesk component | true | Boolean |
| camel.component.zendesk.resolve-property-placeholders | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | Boolean |
| camel.component.zendesk.zendesk | To use a shared Zendesk instance. The option is a org.zendesk.client.v2.Zendesk type. | String |
381.3. URI format
zendesk://endpoint?[options]
381.4. Producer Endpoints:
Producer endpoints can use endpoint names and associated options described next.
381.5. Consumer Endpoints:
Any of the producer endpoints can be used as a consumer endpoint. Consumer endpoints can use Scheduled Poll Consumer Options with a consumer. prefix to schedule endpoint invocation. Consumer endpoints that return an array or collection will generate one exchange per element, and their routes will be executed once for each exchange.
381.6. Message header
Any of the options can be provided in a message header for producer endpoints with CamelZendesk. prefix. In principal, parameter names are same as the arugument name of each API methods on the original org.zendesk.client.v2.Zendesk class. However some of them are renamed to the other name to avoid confliction in the camel API component framework. To see actual parameter name, please check org.apache.camel.component.zendesk.internal.ZendeskApiMethod.
381.7. Message body
All result message bodies utilize objects provided by the Zendesk Java Client. Producer endpoints can specify the option name for incoming message body in the inBody endpoint parameter.
