Update Webhook - Godiligent API Documentation

Update a webhook

curl --request PATCH \
  --url https://api.godiligent.ai/webhooks/{webhook_id} \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "webhook_url": "<string>",
  "is_active": true,
  "secret": "<string>",
  "events": []
}
'

import requests

url = "https://api.godiligent.ai/webhooks/{webhook_id}"

payload = {
    "webhook_url": "<string>",
    "is_active": True,
    "secret": "<string>",
    "events": []
}
headers = {
    "X-API-KEY": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {'X-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({webhook_url: '<string>', is_active: true, secret: '<string>', events: []})
};

fetch('https://api.godiligent.ai/webhooks/{webhook_id}', 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.godiligent.ai/webhooks/{webhook_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'webhook_url' => '<string>',
    'is_active' => true,
    'secret' => '<string>',
    'events' => [
        
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-API-KEY: <api-key>"
  ],
]);

$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.godiligent.ai/webhooks/{webhook_id}"

	payload := strings.NewReader("{\n  \"webhook_url\": \"<string>\",\n  \"is_active\": true,\n  \"secret\": \"<string>\",\n  \"events\": []\n}")

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

	req.Header.Add("X-API-KEY", "<api-key>")
	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.patch("https://api.godiligent.ai/webhooks/{webhook_id}")
  .header("X-API-KEY", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"webhook_url\": \"<string>\",\n  \"is_active\": true,\n  \"secret\": \"<string>\",\n  \"events\": []\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.godiligent.ai/webhooks/{webhook_id}")

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

request = Net::HTTP::Patch.new(url)
request["X-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"webhook_url\": \"<string>\",\n  \"is_active\": true,\n  \"secret\": \"<string>\",\n  \"events\": []\n}"

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

{
  "id": "<string>",
  "webhook_url": "<string>",
  "is_active": true,
  "has_secret": true,
  "last_delivery_at": "2023-11-07T05:31:56Z",
  "last_delivery_status": 123,
  "events": []
}

PATCH

/

webhooks

/

{webhook_id}

Update a webhook

curl --request PATCH \
  --url https://api.godiligent.ai/webhooks/{webhook_id} \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "webhook_url": "<string>",
  "is_active": true,
  "secret": "<string>",
  "events": []
}
'

import requests

url = "https://api.godiligent.ai/webhooks/{webhook_id}"

payload = {
    "webhook_url": "<string>",
    "is_active": True,
    "secret": "<string>",
    "events": []
}
headers = {
    "X-API-KEY": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {'X-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({webhook_url: '<string>', is_active: true, secret: '<string>', events: []})
};

fetch('https://api.godiligent.ai/webhooks/{webhook_id}', 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.godiligent.ai/webhooks/{webhook_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'webhook_url' => '<string>',
    'is_active' => true,
    'secret' => '<string>',
    'events' => [
        
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-API-KEY: <api-key>"
  ],
]);

$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.godiligent.ai/webhooks/{webhook_id}"

	payload := strings.NewReader("{\n  \"webhook_url\": \"<string>\",\n  \"is_active\": true,\n  \"secret\": \"<string>\",\n  \"events\": []\n}")

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

	req.Header.Add("X-API-KEY", "<api-key>")
	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.patch("https://api.godiligent.ai/webhooks/{webhook_id}")
  .header("X-API-KEY", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"webhook_url\": \"<string>\",\n  \"is_active\": true,\n  \"secret\": \"<string>\",\n  \"events\": []\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.godiligent.ai/webhooks/{webhook_id}")

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

request = Net::HTTP::Patch.new(url)
request["X-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"webhook_url\": \"<string>\",\n  \"is_active\": true,\n  \"secret\": \"<string>\",\n  \"events\": []\n}"

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

{
  "id": "<string>",
  "webhook_url": "<string>",
  "is_active": true,
  "has_secret": true,
  "last_delivery_at": "2023-11-07T05:31:56Z",
  "last_delivery_status": 123,
  "events": []
}

Endpoint

PATCH /webhooks/{webhook_id} Partially updates an existing webhook. Only the fields you supply are changed; omitted fields keep their current values.

Path Parameters

Parameter	Type	Required	Description
webhook_id	string	Yes	The ID of the webhook to update.

Request Body

All fields are optional. Supply only what you want to change.

Field	Type	Description
webhook_url	string	HTTPS URL to receive webhook events. Must start with `https://`.
secret	string	Write-only. Omit to keep the current secret, send an empty string to remove it, or send a value to replace it.
is_active	boolean	Whether the webhook is active.
events	string[]	Replaces the full list of subscribed event types.

Example Request

Disable a webhook and narrow its event filter, leaving the secret untouched:

{
  "is_active": false,
  "events": ["search_completed"]
}

Responses

200 OK

The updated webhook (the secret is never echoed — has_secret indicates whether one is set).

{
  "id": "df89eb16-4c6a-439f-b668-7cca0cd786fa",
  "webhook_url": "https://www.testing-webhooks.com",
  "is_active": false,
  "has_secret": true,
  "status": "disabled",
  "last_delivery_at": "2025-07-31T02:51:34.155Z",
  "last_delivery_status": 200,
  "events": ["search_completed"]
}

400 Bad Request

Input validation failed.

404 Not Found

No webhook with that ID exists for the authenticated customer.

500 Internal Server Error

Unexpected error occurred.

Authentication

This endpoint requires authentication. You can only update webhooks owned by the authenticated customer.

Authorizations

X-API-KEY

string

header

required

Path Parameters

webhook_id

string

required

ID of the webhook to update.

Body

application/json

webhook_url

string<uri>

Must be a valid URL starting with https.

is_active

boolean

secret

string

Write-only. Omit to keep the current secret, send an empty string to remove it, or send a value to replace it.

events

enum<string>[]

Available options:

cdd_state_changed,

monitoring_alert_fired,

cdd_document_fetched,

search_completed,

alert_remediated,

flow_run_completed,

flow_run_failed

Response

The updated webhook.

id

string

Unique ID for the webhook.

webhook_url

string<uri>

is_active

boolean

has_secret

boolean

Whether a signing secret is configured. The secret itself is never returned.

status

enum<string>

Derived health: disabled when inactive, failing when the last delivery returned a non-2xx status, otherwise active.

Available options:

active,

failing,

disabled

last_delivery_at

string<date-time> | null

Timestamp of the most recent delivery attempt, or null if none.

last_delivery_status

integer | null

HTTP status code of the most recent delivery attempt, or null if none.

events

enum<string>[]

Available options:

cdd_state_changed,

monitoring_alert_fired,

cdd_document_fetched,

search_completed,

alert_remediated,

flow_run_completed,

flow_run_failed

Get Webhook Delete Webhook