Skip to main content
POST
/
v2
/
workspace
/
advancedwebhook
/
endpoints
/
get
Get Advanced Webhook Endpoints
curl --request POST \
  --url https://api.velt.dev/v2/workspace/advancedwebhook/endpoints/get \
  --header 'Content-Type: application/json' \
  --header 'x-velt-api-key: <x-velt-api-key>' \
  --header 'x-velt-auth-token: <x-velt-auth-token>' \
  --data '
{
  "data": {
    "limit": 123,
    "iterator": "<string>"
  }
}
'
{
  "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
    }
  }
}
Use this API to list the webhook delivery endpoints configured for a workspace. Results are paginated via an opaque iterator cursor.
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 endpoint.
Advanced webhooks must be enabled for the workspace first via Update Advanced Webhook Config with { "isEnabled": true }. Otherwise this endpoint returns a FAILED_PRECONDITION error.

​
Endpoint

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

​
Headers

​
x-velt-api-key
string
required
Your API key.
​
x-velt-auth-token
string
required
Your Auth Token.

​
Body

​
Params

​
data
object
required

​
Example Request

{
  "data": {
    "limit": 50
  }
}

​
Example Response

​
Success Response

{
  "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
    }
  }
}
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.

​
Failure Response

{
  "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)

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

{
  "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
    }
  }
}