> ## 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.

# Create Advanced Webhook Endpoint

Use this API to create a new webhook delivery endpoint 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]
>
> Advanced webhooks must be enabled for the workspace first via [Update Advanced Webhook Config](https://velt.dev/docs/api-reference/rest-apis/v2/workspace/advancedwebhookconfig-update.md) with `{ "isEnabled": true }`. Otherwise this endpoint returns a `FAILED_PRECONDITION` error.

> [!NOTE]
>
> **Signing secret.** The endpoint's signing secret is always generated server-side — it is never accepted from the request. Retrieve it after creation via [Get Advanced Webhook Endpoint Secret](https://velt.dev/docs/api-reference/rest-apis/v2/workspace/advancedwebhook-endpoints-secret-get.md) and use it to verify webhook payload signatures.

# Endpoint

`POST https://api.velt.dev/v2/workspace/advancedwebhook/endpoints/create`

# 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

#### Params

**data** `object` *required*

**properties**

**url** `string` *required*

The URL that will receive webhook events. Must be a valid `http(s)` URL.

**description** `string`

Human-readable description of the endpoint.

**filterTypes** `string[]`

Event types this endpoint subscribes to (e.g. `["comment.add", "comment.update"]`). If omitted, the endpoint receives all event types. Must be a non-empty array when provided. See [Webhooks](https://velt.dev/docs/webhooks/advanced.md) for the full list of event types.

**channels** `string[]`

Channels this endpoint listens to. If omitted, the endpoint receives events from all channels. Must be a non-empty array when provided.

**disabled** `boolean`

Whether the endpoint is created in a disabled state. Defaults to `false`.

**rateLimit** `number`

Maximum deliveries per second for this endpoint. Positive integer.

**uid** `string`

Optional unique identifier you can assign to the endpoint.

**metadata** `object`

Key-value pairs (string values) attached to the endpoint.

# Example Request

```JSON theme={null}
{
  "data": {
    "url": "https://example.com/webhooks/velt",
    "description": "Primary endpoint",
    "filterTypes": ["comment.add", "comment.update"]
  }
}
```

# Example Response

#### Success Response

```JSON theme={null}
{
  "result": {
    "status": "success",
    "message": "Advanced webhook endpoint created successfully.",
    "data": {
      "id": "ep_2vK9mPzGqLxYwBnRtCdHsJfAeUo",
      "url": "https://example.com/webhooks/velt",
      "description": "Primary endpoint",
      "filterTypes": ["comment.add", "comment.update"],
      "channels": null,
      "disabled": false,
      "rateLimit": null,
      "uid": null,
      "createdAt": "2026-06-01T10:15:30.000Z",
      "updatedAt": "2026-06-01T10:15:30.000Z"
    }
  }
}
```

#### Failure Response

```JSON theme={null}
{
  "error": {
    "status": "INVALID_ARGUMENT",
    "message": "url must be a valid http(s) URL."
  }
}
```

#### Failure Response (advanced webhooks disabled)

```JSON theme={null}
{
  "error": {
    "status": "FAILED_PRECONDITION",
    "message": "Advanced webhooks are disabled for this workspace. Enable them via POST /v2/workspace/advancedwebhookconfig/update with { \"isEnabled\": true }."
  }
}
```

```js theme={null}
{
  "result": {
    "status": "success",
    "message": "Advanced webhook endpoint created successfully.",
    "data": {
      "id": "ep_2vK9mPzGqLxYwBnRtCdHsJfAeUo",
      "url": "https://example.com/webhooks/velt",
      "description": "Primary endpoint",
      "filterTypes": ["comment.add", "comment.update"],
      "channels": null,
      "disabled": false,
      "rateLimit": null,
      "uid": null,
      "createdAt": "2026-06-01T10:15:30.000Z",
      "updatedAt": "2026-06-01T10:15:30.000Z"
    }
  }
}
```


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