Update Advanced Webhook Config

POST /v2/workspace/advancedwebhookconfig/update

Update Advanced Webhook Config

cURL

curl --request POST \
  --url https://api.velt.dev/v2/workspace/advancedwebhookconfig/update \
  --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": {
    "isEnabled": true,
    "encryptData": true,
    "encodeData": true,
    "publicKey": "<string>",
    "enableDataProtection": true
  }
}
'

import requests

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

payload = { "data": {
        "isEnabled": True,
        "encryptData": True,
        "encodeData": True,
        "publicKey": "<string>",
        "enableDataProtection": True
    } }
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: {
      isEnabled: true,
      encryptData: true,
      encodeData: true,
      publicKey: '<string>',
      enableDataProtection: true
    }
  })
};

fetch('https://api.velt.dev/v2/workspace/advancedwebhookconfig/update', 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/update",
  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' => [
        'isEnabled' => true,
        'encryptData' => true,
        'encodeData' => true,
        'publicKey' => '<string>',
        'enableDataProtection' => true
    ]
  ]),
  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/advancedwebhookconfig/update"

	payload := strings.NewReader("{\n  \"data\": {\n    \"isEnabled\": true,\n    \"encryptData\": true,\n    \"encodeData\": true,\n    \"publicKey\": \"<string>\",\n    \"enableDataProtection\": true\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/advancedwebhookconfig/update")
  .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    \"isEnabled\": true,\n    \"encryptData\": true,\n    \"encodeData\": true,\n    \"publicKey\": \"<string>\",\n    \"enableDataProtection\": true\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.velt.dev/v2/workspace/advancedwebhookconfig/update")

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    \"isEnabled\": true,\n    \"encryptData\": true,\n    \"encodeData\": true,\n    \"publicKey\": \"<string>\",\n    \"enableDataProtection\": true\n  }\n}"

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

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

Use this API to update the advanced webhook configuration for a workspace. At least one of isEnabled, encryptData, encodeData, publicKey or enableDataProtection must be provided.

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 Update Webhook Config.

First enable. If advanced webhooks have never been configured for the workspace, the first request must include isEnabled: true — this provisions the underlying webhook application for your workspace. Sending only other fields before the first enable returns a FAILED_PRECONDITION error. After the first enable, you can manage delivery endpoints via the endpoint management APIs.

Partial update. Only the fields you send are changed; all other stored values are preserved. The response data echoes the latest post-write state — the same shape returned by Get Advanced Webhook Config.

Endpoint

POST https://api.velt.dev/v2/workspace/advancedwebhookconfig/update

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

isEnabled · boolean

Whether to enable advanced webhooks. Must be true on the very first configuration request.

encryptData · boolean

Whether to encrypt the webhook payload.

encodeData · boolean

Whether to base64 encode the webhook payload.

publicKey · string

Public key used for payload encryption.

enableDataProtection · boolean

Whether to enable data protection for webhook payloads.

Example Request

{
  "data": {
    "isEnabled": true,
    "encryptData": false,
    "encodeData": false
  }
}

Example Response

Success Response

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

Failure Response

{
  "error": {
    "status": "INVALID_ARGUMENT",
    "message": "At least one of isEnabled, encryptData, encodeData, publicKey or enableDataProtection must be provided."
  }
}

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