# Webhook

The **Webhook** object facilitates the integration of your application with the mio.ID platform by enabling real-time event notifications. This object defines a configured endpoint in your system that receives notifications about actions or changes in mio.ID services, ensuring seamless automation and synchronization.

<table data-full-width="true"><thead><tr><th width="224">Field</th><th width="188">Type</th><th width="551">Description</th></tr></thead><tbody><tr><td><code>type</code></td><td><code>string</code></td><td>Specifies the type of webhook.</td></tr><tr><td><code>url</code></td><td><code>string</code></td><td>The URL of your service to be used as the webhook endpoint.</td></tr><tr><td><code>secret</code></td><td><code>string</code></td><td>A secret key used to cipher messages for secure communication.<br><strong>Note:</strong> Refer to <strong>Webhooks Configuration</strong> for details about the ciphering process.</td></tr><tr><td><code>authorization</code></td><td><code>object</code></td><td><p>Provides options for securing your service using one of the following methods:</p><ul><li>Basic authentication</li><li>Bearer token authorization</li><li>API key</li></ul></td></tr><tr><td><code>headers</code></td><td><code>object</code></td><td>Allows configuration of additional metadata to be included in the headers for your service. This ensures compatibility with services requiring custom metadata.</td></tr></tbody></table>

This structure supports robust, secure integration for handling real-time updates and actions on the mio.ID platform.


---

# Agent Instructions: Querying This Documentation

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

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs-business.mio.id/api-reference/data-dictionary/objects/webhook.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
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.