> For the complete documentation index, see [llms.txt](https://docs.couchdrop.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.couchdrop.io/integrations/siem/webhook.md).

# Webhook

Learn how to send events via a Webhook to your logging system from Couchdrop

## Overview

Webhook logging allows Couchdrop to send events directly to an external logging or SIEM system using a Webhook endpoint.

You can choose which Couchdrop events to send and optionally include additional HTTP headers or attributes in the JSON payload.

## How to configure Webhook logging

{% hint style="warning" %}

#### Before you start

To configure Webhook logging, you will need:

* A Couchdrop account with access to the SIEM logging settings
* A Webhook endpoint
* An Event JSON attribute
  {% endhint %}

{% stepper %}
{% step %}

### Open Webhook logging

Log in to Couchdrop and navigate to **Admin Panel** → **Logging**.

Select **Connect** or **Manage** on the **Webhook** provider.
{% endstep %}

{% step %}

### Configure the Webhook

Select the events you want Couchdrop to send, then configure the required Webhook settings:

* **Webhook Endpoint**
* **Event JSON attribute**

You can also configure **Additional Headers**, such as headers required for basic authentication, and **Additional Attributes** to include additional values in the JSON object sent to your logging system.
{% endstep %}

{% step %}

### Save the Webhook

Click **Save Updates** to save the configuration.

Couchdrop will send the selected events to the configured Webhook endpoint.
{% endstep %}
{% endstepper %}

## Webhook Settings

| Setting                   | Description                                                                                         |
| ------------------------- | --------------------------------------------------------------------------------------------------- |
| **Webhook Endpoint**      | The endpoint Couchdrop sends logging events to.                                                     |
| **Event JSON attribute**  | The JSON attribute used for the Couchdrop event.                                                    |
| **Additional Headers**    | Optional HTTP headers sent with the Webhook request, such as headers used for basic authentication. |
| **Additional Attributes** | Optional attributes added to the JSON object sent to your logging system.                           |

## Couchdrop event format

Couchdrop sends logging events as JSON. The properties included in an event depend on the activity that generated it.

An example Couchdrop event is shown below:

```json
{
  "id": "",
  "event_id": "",
  "token": "",
  "account": "",
  "organisation_id": "",
  "filename": "",
  "filename_relative": "",
  "path": "",
  "relative_path": "",
  "timestamp": 1750721574,
  "TimeGenerated": "2025-06-24T11:32:54.000Z",
  "authenticated_user": "",
  "authenticated_user_id": "",
  "storage_engine": "",
  "storage_engine_id": "",
  "event_type": "",
  "ip_address": "",
  "success": true,
  "total_size": 0,
  "file_size": 0,
  "additional_info": "",
  "system": "",
  "transaction_id": "",
  "region": "",
  "workflow_id": "",
  "workflow_action": "",
  "node": "",
  "message": "",
  "is_support_generated": false,
  "inbox_id": "",
  "shared_link_id": "",
  "error_type": "",
  "error_message": "",
  "error_original": "",
  "elapsed": 0,
  "as2_mdn_payload": "",
  "as2_station_id": "",
  "inbound_s3_bucket_id": "",
  "inbound_s3_bucket_key_id": "",
  "sender": "",
  "ingress_retry": 0,
  "text": "",
  "ingress": true,
  "ingress_status": {}
}
```

The payload provides information about the event itself together with relevant user, file, storage, workflow, transfer, and error information when applicable.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.couchdrop.io/integrations/siem/webhook.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.