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

Use this API to list the webhook delivery endpoints configured for a workspace. Results are paginated via an opaque `iterator` cursor.

<Info>
  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](/api-reference/rest-apis/v2/workspace/authtokens-get) endpoint.
</Info>

<Note>
  Advanced webhooks must be enabled for the workspace first via [Update Advanced Webhook Config](/api-reference/rest-apis/v2/workspace/advancedwebhookconfig-update) with `{ "isEnabled": true }`. Otherwise this endpoint returns a `FAILED_PRECONDITION` error.
</Note>

# Endpoint

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

# Headers

<ParamField header="x-velt-api-key" type="string" required>
  Your API key.
</ParamField>

<ParamField header="x-velt-auth-token" type="string" required>
  Your [Auth Token](/security/auth-tokens).
</ParamField>

# Body

#### Params

<ParamField body="data" type="object" required>
  <Expandable title="properties">
    <ParamField body="limit" type="number">
      Maximum number of endpoints to return. Integer between `1` and `250`.
    </ParamField>

    <ParamField body="iterator" type="string">
      Pagination cursor returned by a previous call. Omit to start from the first page.
    </ParamField>
  </Expandable>
</ParamField>

# Example Request

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

# Example Response

#### Success Response

```JSON theme={null}
{
  "result": {
    "status": "success",
    "message": "Advanced webhook endpoints retrieved successfully.",
    "data": {
      "endpoints": [
        {
          "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-05T08:42:11.000Z"
        }
      ],
      "iterator": null,
      "prevIterator": null,
      "done": true
    }
  }
}
```

<Note>
  When `done` is `false`, pass the returned `iterator` in the next request to fetch the following page. Optional endpoint fields that are unset are returned as explicit `null` values.
</Note>

#### Failure Response

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

#### 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 }."
  }
}
```

<ResponseExample>
  ```js theme={null}
  {
    "result": {
      "status": "success",
      "message": "Advanced webhook endpoints retrieved successfully.",
      "data": {
        "endpoints": [
          {
            "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-05T08:42:11.000Z"
          }
        ],
        "iterator": null,
        "prevIterator": null,
        "done": true
      }
    }
  }
  ```
</ResponseExample>