WebhookService
Update Webhook Endpoint
Changes the delivery url, the subscribed event types, or both. Omitted fields keep their current value; the signing secret is never changed here (use RotateWebhookEndpointSecret).
Required scope: webhooks:manage
Error Codes:
- WEBHOOK_NOT_FOUND: No such endpoint in the caller’s tenant.
- DEVELOPER.WEBHOOK_URL_INVALID: The url is not https or resolves to a private address.
- DEVELOPER.WEBHOOK_EVENT_INVALID: An event type is unknown.
PATCH
/
developer
/
v1
/
webhook_endpoints
/
{id}
Update Webhook Endpoint
curl --request PATCH \
--url https://app.doodocs.kz/api/developer/v1/webhook_endpoints/{id} \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"id": "<string>",
"event_types": [
"<string>"
],
"url": "<string>"
}
'import requests
url = "https://app.doodocs.kz/api/developer/v1/webhook_endpoints/{id}"
payload = {
"id": "<string>",
"event_types": ["<string>"],
"url": "<string>"
}
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({id: '<string>', event_types: ['<string>'], url: '<string>'})
};
fetch('https://app.doodocs.kz/api/developer/v1/webhook_endpoints/{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://app.doodocs.kz/api/developer/v1/webhook_endpoints/{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([
'id' => '<string>',
'event_types' => [
'<string>'
],
'url' => '<string>'
]),
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://app.doodocs.kz/api/developer/v1/webhook_endpoints/{id}"
payload := strings.NewReader("{\n \"id\": \"<string>\",\n \"event_types\": [\n \"<string>\"\n ],\n \"url\": \"<string>\"\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://app.doodocs.kz/api/developer/v1/webhook_endpoints/{id}")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"id\": \"<string>\",\n \"event_types\": [\n \"<string>\"\n ],\n \"url\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.doodocs.kz/api/developer/v1/webhook_endpoints/{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 \"id\": \"<string>\",\n \"event_types\": [\n \"<string>\"\n ],\n \"url\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"endpoint": {
"active": true,
"create_time": "2023-11-07T05:31:56Z",
"disabled_reason": "<string>",
"event_types": [
"<string>"
],
"id": "<string>",
"last_success_at": "2023-11-07T05:31:56Z",
"previous_secret_expires_at": "2023-11-07T05:31:56Z",
"update_time": "2023-11-07T05:31:56Z",
"url": "<string>"
}
}{
"code": 123,
"details": [
{
"@type": "<string>"
}
],
"message": "<string>"
}Авторизации
Параметры пути
Endpoint id (UUID) to update.
Тело
application/json
Endpoint id (UUID) to update.
Replacement set of event types; the same closed vocabulary as on create. An empty list keeps the current subscription — it does not unsubscribe.
New delivery target, with the same rules as on create. Omit to keep the current url. Changing it also clears the consecutive-failure counter, so a fix does not inherit the dead host's failures.
Ответ
OK
The endpoint after the update.
Show child attributes
Show child attributes
⌘I
Update Webhook Endpoint
curl --request PATCH \
--url https://app.doodocs.kz/api/developer/v1/webhook_endpoints/{id} \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"id": "<string>",
"event_types": [
"<string>"
],
"url": "<string>"
}
'import requests
url = "https://app.doodocs.kz/api/developer/v1/webhook_endpoints/{id}"
payload = {
"id": "<string>",
"event_types": ["<string>"],
"url": "<string>"
}
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({id: '<string>', event_types: ['<string>'], url: '<string>'})
};
fetch('https://app.doodocs.kz/api/developer/v1/webhook_endpoints/{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://app.doodocs.kz/api/developer/v1/webhook_endpoints/{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([
'id' => '<string>',
'event_types' => [
'<string>'
],
'url' => '<string>'
]),
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://app.doodocs.kz/api/developer/v1/webhook_endpoints/{id}"
payload := strings.NewReader("{\n \"id\": \"<string>\",\n \"event_types\": [\n \"<string>\"\n ],\n \"url\": \"<string>\"\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://app.doodocs.kz/api/developer/v1/webhook_endpoints/{id}")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"id\": \"<string>\",\n \"event_types\": [\n \"<string>\"\n ],\n \"url\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.doodocs.kz/api/developer/v1/webhook_endpoints/{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 \"id\": \"<string>\",\n \"event_types\": [\n \"<string>\"\n ],\n \"url\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"endpoint": {
"active": true,
"create_time": "2023-11-07T05:31:56Z",
"disabled_reason": "<string>",
"event_types": [
"<string>"
],
"id": "<string>",
"last_success_at": "2023-11-07T05:31:56Z",
"previous_secret_expires_at": "2023-11-07T05:31:56Z",
"update_time": "2023-11-07T05:31:56Z",
"url": "<string>"
}
}{
"code": 123,
"details": [
{
"@type": "<string>"
}
],
"message": "<string>"
}