Ce contenu n'est pas disponible dans la langue sélectionnée.
Chapter 140. Webhook
Only consumer is supported
The Webhook meta component allows other Camel components to configure webhooks on a remote webhook provider and listening for them.
The following components currently provide webhook endpoints:
- Telegram
Typically, other components that support webhook will bring this dependency transitively.
140.1. Dependencies
When using webhook with Red Hat build of Camel Spring Boot make sure to use the following Maven dependency to have support for auto configuration:
<dependency> <groupId>org.apache.camel.springboot</groupId> <artifactId>camel-webhook-starter</artifactId> </dependency>
140.2. URI Format
webhook:endpoint[?options]
140.3. Configuring Options
Camel components are configured on two levels:
- Component level
- Endpoint level
140.3.1. Component Level Options
The component level is the highest level. The configurations you define at this level are inherited by all the endpoints. For example, a component can have security settings, credentials for authentication, urls for network connection, and so on.
Since components typically have pre-configured defaults for the most common cases, you may need to only configure a few component options, or maybe none at all.
You can configure components with Component DSL in a configuration file (application.properties|yaml), or directly with Java code.
140.3.2. Endpoint Level Options
At the Endpoint level you have many options, which you can use to configure what you want the endpoint to do. The options are categorized according to whether the endpoint is used as a consumer (from) or as a producer (to) or used for both.
You can configure endpoints directly in the endpoint URI as path and query parameters. You can also use Endpoint DSL and DataFormat DSL as type safe ways of configuring endpoints and data formats in Java.
When configuring options, use Property Placeholders for urls, port numbers, sensitive information, and other settings.
Placeholders allows you to externalize the configuration from your code, giving you more flexible and reusable code.
140.4. Component Options
The Webhook component supports 8 options, which are listed below.
| Name | Description | Default | Type |
|---|---|---|---|
| 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 |
| webhookAutoRegister (consumer) | Automatically register the webhook at startup and unregister it on shutdown. | true | boolean |
| webhookBasePath (consumer) | 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. | String | |
| webhookComponentName (consumer) | The Camel Rest component to use for the REST transport, such as netty-http. | String | |
| webhookExternalUrl (consumer) | The URL of the current service as seen by the webhook provider. | String | |
| webhookPath (consumer) | The path where the webhook endpoint will be exposed (relative to basePath, if any). | String | |
| autowiredEnabled (advanced) | Whether autowiring is enabled. This is used for automatic autowiring options (the option must be marked as autowired) by looking up in the registry to find if there is a single instance of matching type, which then gets configured on the component. This can be used for automatic configuring JDBC data sources, JMS connection factories, AWS Clients, etc. | true | boolean |
| configuration (advanced) | Set the default configuration for the webhook meta-component. | WebhookConfiguration |
140.5. Endpoint Options
The Webhook endpoint is configured using URI syntax:
webhook:endpointUri
with the following path and query parameters:
140.5.1. Path Parameters (1 parameters)
| Name | Description | Default | Type |
|---|---|---|---|
| endpointUri (consumer) | Required The delegate uri. Must belong to a component that supports webhooks. | String |
140.5.2. Query Parameters (8 parameters)
| Name | Description | Default | Type |
|---|---|---|---|
| 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 |
| webhookAutoRegister (consumer) | Automatically register the webhook at startup and unregister it on shutdown. | true | boolean |
| webhookBasePath (consumer) | 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. | String | |
| webhookComponentName (consumer) | The Camel Rest component to use for the REST transport, such as netty-http. | String | |
| webhookExternalUrl (consumer) | The URL of the current service as seen by the webhook provider. | String | |
| webhookPath (consumer) | The path where the webhook endpoint will be exposed (relative to basePath, if any). | String | |
| exceptionHandler (consumer (advanced)) | 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 (advanced)) | Sets the exchange pattern when the consumer creates an exchange. Enum values:
| ExchangePattern |
140.6. Examples
Examples of webhook component are provided in the documentation of the delegate components that support it.
140.7. Spring Boot Auto-Configuration
The component supports 9 options, which are listed below.
| Name | Description | Default | Type |
|---|---|---|---|
| camel.component.webhook.autowired-enabled | Whether autowiring is enabled. This is used for automatic autowiring options (the option must be marked as autowired) by looking up in the registry to find if there is a single instance of matching type, which then gets configured on the component. This can be used for automatic configuring JDBC data sources, JMS connection factories, AWS Clients, etc. | true | Boolean |
| camel.component.webhook.bridge-error-handler | 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 |
| camel.component.webhook.configuration | Set the default configuration for the webhook meta-component. The option is a org.apache.camel.component.webhook.WebhookConfiguration type. | WebhookConfiguration | |
| camel.component.webhook.enabled | Whether to enable auto configuration of the webhook component. This is enabled by default. | Boolean | |
| camel.component.webhook.webhook-auto-register | Automatically register the webhook at startup and unregister it on shutdown. | true | Boolean |
| camel.component.webhook.webhook-base-path | 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. | String | |
| camel.component.webhook.webhook-component-name | The Camel Rest component to use for the REST transport, such as netty-http. | String | |
| camel.component.webhook.webhook-external-url | The URL of the current service as seen by the webhook provider. | String | |
| camel.component.webhook.webhook-path | The path where the webhook endpoint will be exposed (relative to basePath, if any). | String |
