Webhook

Since Camel 3.0

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

Maven users can add the following dependency to their pom.xml for this component:

<dependency>
    <groupId>org.apache.camel</groupId>
    <artifactId>camel-webhook</artifactId>
    <version>x.x.x</version>
    <!-- use the same version as your Camel core version -->
</dependency>

Typically, other components that support webhook will bring this dependency transitively.

URI Format

webhook:endpoint[?options]

Configuring Options

Camel components are configured on two separate levels:

  • component level

  • endpoint level

Configuring Component Options

The component level is the highest level which holds general and common configurations that are inherited by the endpoints. For example a component may have security settings, credentials for authentication, urls for network connection and so forth.

Some components only have a few options, and others may have many. Because components typically have pre configured defaults that are commonly used, then you may often only need to configure a few options on a component; or none at all.

Configuring components can be done with the Component DSL, in a configuration file (application.properties|yaml), or directly with Java code.

Configuring Endpoint Options

Where you find yourself configuring the most is on endpoints, as endpoints often have many options, which allows you to configure what you need the endpoint to do. The options are also categorized into whether the endpoint is used as consumer (from) or as a producer (to), or used for both.

Configuring endpoints is most often done directly in the endpoint URI as path and query parameters. You can also use the Endpoint DSL as a type safe way of configuring endpoints.

A good practice when configuring options is to use Property Placeholders, which allows to not hardcode urls, port numbers, sensitive information, and other settings. In other words placeholders allows to externalize the configuration from your code, and gives more flexibility and reuse.

The following two sections lists all the options, firstly for the component followed by the endpoint.

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.

boolean

webhookAutoRegister (consumer)

Automatically register the webhook at startup and unregister it on shutdown.

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.

boolean

configuration (advanced)

Set the default configuration for the webhook meta-component.

WebhookConfiguration

Endpoint Options

The Webhook endpoint is configured using URI syntax:

webhook:endpointUri

with the following path and query parameters:

Path Parameters (1 parameters)

Name Description Default Type

endpointUri (consumer)

Required The delegate uri. Must belong to a component that supports webhooks.

String

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.

boolean

webhookAutoRegister (consumer)

Automatically register the webhook at startup and unregister it on shutdown.

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:

  • InOnly

  • InOut

  • InOptionalOut

ExchangePattern

Examples

Examples of webhook component are provided in the documentation of the delegate components that support it.

Spring Boot Auto-Configuration

When using webhook with 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>
  <version>x.x.x</version>
  <!-- use the same version as your Camel core version -->
</dependency>

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