components/camel-webhook/src/main/docs/webhook-component.adoc

= Webhook Component
:doctitle: Webhook
:shortname: webhook
:artifactid: camel-webhook
:description: Expose webhook endpoints to receive push notifications for other Camel components.
:since: 3.0
:supportlevel: Stable
:tabs-sync-option:
:component-header: Only consumer is supported
//Manually maintained attributes
:camel-spring-boot-name: webhook

*Since Camel {since}*

*{component-header}*


The Webhook meta-component allows other Camel components to configure webhooks on a remote webhook provider and
 listen for them.

.The following components currently provide webhook endpoints:

- xref:telegram-component.adoc[Camel Telegram]
- xref:whatsapp-component.adoc[Camel WhatsApp]

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

[source,xml]
----
<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]
----



// component options: START
include::partial$component-configure-options.adoc[]
include::partial$component-endpoint-options.adoc[]
include::partial$component-endpoint-headers.adoc[]
// component options: END



== Examples

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


include::spring-boot:partial$starter.adoc[]