Get Advanced Webhook Endpoints

POST /v2/workspace/advancedwebhook/endpoints/get

Get Advanced Webhook Endpoints

cURL

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

import requests

url = "https://api.velt.dev/v2/workspace/advancedwebhook/endpoints/get"

payload = { "data": {
        "limit": 123,
        "iterator": "<string>"
    } }
headers = {
    "x-velt-api-key": "<x-velt-api-key>",
    "x-velt-auth-token": "<x-velt-auth-token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'x-velt-api-key': '<x-velt-api-key>',
    'x-velt-auth-token': '<x-velt-auth-token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({data: {limit: 123, iterator: '<string>'}})
};

fetch('https://api.velt.dev/v2/workspace/advancedwebhook/endpoints/get', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.velt.dev/v2/workspace/advancedwebhook/endpoints/get",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'data' => [
        'limit' => 123,
        'iterator' => '<string>'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-velt-api-key: <x-velt-api-key>",
    "x-velt-auth-token: <x-velt-auth-token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.velt.dev/v2/workspace/advancedwebhook/endpoints/get"

	payload := strings.NewReader("{\n  \"data\": {\n    \"limit\": 123,\n    \"iterator\": \"<string>\"\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-velt-api-key", "<x-velt-api-key>")
	req.Header.Add("x-velt-auth-token", "<x-velt-auth-token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.velt.dev/v2/workspace/advancedwebhook/endpoints/get")
  .header("x-velt-api-key", "<x-velt-api-key>")
  .header("x-velt-auth-token", "<x-velt-auth-token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"data\": {\n    \"limit\": 123,\n    \"iterator\": \"<string>\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.velt.dev/v2/workspace/advancedwebhook/endpoints/get")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-velt-api-key"] = '<x-velt-api-key>'
request["x-velt-auth-token"] = '<x-velt-auth-token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"data\": {\n    \"limit\": 123,\n    \"iterator\": \"<string>\"\n  }\n}"

response = http.request(request)
puts response.read_body

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

Show properties

limit · number

Maximum number of endpoints to return. Integer between 1 and 250.

iterator · string

Pagination cursor returned by a previous call. Omit to start from the first page.

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