> ## Documentation Index
> Fetch the complete documentation index at: https://docs.keephq.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# Webhook

> A webhook is a method used to send real-time data from one application to another whenever a specific event occurs

## Authentication

This provider requires authentication.

* **url**: Webhook URL (required: True, sensitive: False)
* **verify**: Enable SSL verification (required: False, sensitive: False)
* **method**: HTTP method (required: True, sensitive: False)
* **http\_basic\_authentication\_username**: HTTP basic authentication - Username (required: False, sensitive: False)
* **http\_basic\_authentication\_password**: HTTP basic authentication - Password (required: False, sensitive: True)
* **api\_key**: API key (required: False, sensitive: True)
* **headers**: Headers (required: False, sensitive: False)

Certain scopes may be required to perform specific actions or queries via the provider. Below is a summary of relevant scopes and their use cases:

* **send\_webhook**:  (mandatory)

## In workflows

This provider can be used in workflows.

As "step" to query data, example:

```yaml theme={null}
steps:
    - name: Query webhook
      provider: webhook
      config: "{{ provider.my_provider_name }}"
      with:
        url: {value}  
        method: {value}  
        http_basic_authentication_username: {value}  
        http_basic_authentication_password: {value}  
        api_key: {value}  
        headers: {value}  
        body: {value}  
        params: {value}  
        fail_on_error: {value}  
```

As "action" to make changes or update data, example:

```yaml theme={null}
actions:
    - name: Query webhook
      provider: webhook
      config: "{{ provider.my_provider_name }}"
      with:
        body: {value}  
        params: {value}  
```

Check the following workflow examples:

* [webhook\_example.yml](https://github.com/keephq/keep/blob/main/examples/workflows/webhook_example.yml)
* [webhook\_example\_foreach.yml](https://github.com/keephq/keep/blob/main/examples/workflows/webhook_example_foreach.yml)
* [zoom\_chat\_example.yml](https://github.com/keephq/keep/blob/main/examples/workflows/zoom_chat_example.yml)