Webhook

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

Metadata

Property	Value
Scheme	`webhook`
Support Level	Stable
Labels	cloud
Version	4.10.2

Maven Dependency

<dependency>
    <groupId>org.apache.camel</groupId>
    <artifactId>camel-webhook</artifactId>
    <version>4.10.2</version>
</dependency>

Endpoint Properties

Name	Type	Required	Default	Description
`endpointUri`	string	✓		The delegate uri. Must belong to a component that supports webhooks.
`webhookAutoRegister`	boolean		`true`	Automatically register the webhook at startup and unregister it on shutdown.
`webhookBasePath`	string			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.
`webhookComponentName`	string			The Camel Rest component to use for the REST transport, such as netty-http.
`webhookExternalUrl`	string			The URL of the current service as seen by the webhook provider
`webhookPath`	string			The path where the webhook endpoint will be exposed (relative to basePath, if any)
`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.