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

# Get Advanced Webhook Config

Use this API to retrieve the current advanced webhook configuration for a workspace.

> [!NOTE]
>
> This endpoint uses **API-key-level auth**: pass `x-velt-api-key` and `x-velt-auth-token` as headers. You can obtain these from the [Get Auth Tokens](https://velt.dev/docs/api-reference/rest-apis/v2/workspace/authtokens-get.md) endpoint.

> [!NOTE]
>
> This endpoint is for **Advanced Webhooks**. For Basic Webhooks, use [Get Webhook Config](https://velt.dev/docs/api-reference/rest-apis/v2/workspace/webhookconfig-get.md).

> [!NOTE]
>
> Advanced webhooks must be available for your workspace. If the feature is not enabled for your workspace, this endpoint returns a `FAILED_PRECONDITION` error. Contact us to enable advanced webhooks.

# Endpoint

`POST https://api.velt.dev/v2/workspace/advancedwebhookconfig/get`

# Headers

**x-velt-api-key** `string` *required*

Your API key.

**x-velt-auth-token** `string` *required*

Your [Auth Token](https://velt.dev/docs/security/auth-tokens.md).

# Body

This endpoint does not require a request body.

# Example Request

```JSON theme={null}
{
  "data": {}
}
```

# Example Response

#### Success Response

```JSON theme={null}
{
  "result": {
    "status": "success",
    "message": "Advanced webhook configuration retrieved successfully.",
    "data": {
      "isEnabled": true,
      "encryptData": false,
      "encodeData": false,
      "publicKey": "",
      "enableDataProtection": false
    }
  }
}
```

> [!NOTE]
>
> If advanced webhooks have never been configured for the workspace, all fields are returned with their defaults (`isEnabled: false`, `encryptData: false`, `encodeData: false`, `publicKey: ""`, `enableDataProtection: false`).

#### Failure Response

```JSON theme={null}
{
  "error": {
    "status": "FAILED_PRECONDITION",
    "message": "Advanced webhooks are not available for this workspace."
  }
}
```

```js theme={null}
{
  "result": {
    "status": "success",
    "message": "Advanced webhook configuration retrieved successfully.",
    "data": {
      "isEnabled": true,
      "encryptData": false,
      "encodeData": false,
      "publicKey": "",
      "enableDataProtection": false
    }
  }
}
```


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.