Webhook

Expose webhook endpoints to receive push notifications for other Camel components.

What’s inside

Webhook component, URI syntax: webhook:endpointUri

Please refer to the above links for usage and configuration details.

Maven coordinates

<dependency>
    <groupId>org.apache.camel.springboot</groupId>
    <artifactId>camel-webhook-starter</artifactId>
</dependency>

Spring Boot Auto-Configuration

The starter 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 (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.	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

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 (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.

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