Get Advanced Webhook Config

POST /v2/workspace/advancedwebhookconfig/get

Get Advanced Webhook Config

cURL

curl --request POST \
  --url https://api.velt.dev/v2/workspace/advancedwebhookconfig/get \
  --header 'x-velt-api-key: <x-velt-api-key>' \
  --header 'x-velt-auth-token: <x-velt-auth-token>'

import requests

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

headers = {
    "x-velt-api-key": "<x-velt-api-key>",
    "x-velt-auth-token": "<x-velt-auth-token>"
}

response = requests.post(url, 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>'
  }
};

fetch('https://api.velt.dev/v2/workspace/advancedwebhookconfig/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/advancedwebhookconfig/get",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => [
    "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"
	"net/http"
	"io"
)

func main() {

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

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

	req.Header.Add("x-velt-api-key", "<x-velt-api-key>")
	req.Header.Add("x-velt-auth-token", "<x-velt-auth-token>")

	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/advancedwebhookconfig/get")
  .header("x-velt-api-key", "<x-velt-api-key>")
  .header("x-velt-auth-token", "<x-velt-auth-token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.velt.dev/v2/workspace/advancedwebhookconfig/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>'

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

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

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

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.

This endpoint is for Advanced Webhooks. For Basic Webhooks, use Get Webhook Config.

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.

Body

This endpoint does not require a request body.

Example Request

{
  "data": {}
}

Example Response

Success Response

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

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

{
  "error": {
    "status": "FAILED_PRECONDITION",
    "message": "Advanced webhooks are not available for this workspace."
  }
}

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