WebhookService

Rotate Webhook Endpoint Secret

Issues a new signing secret and returns it once. The previous secret keeps working for grace_seconds so a receiver can switch over without dropping deliveries: during that window every delivery carries the new signature in Doodocs-Signature and the old one in Doodocs-Signature-Previous. Accept either header until you have deployed the new secret, then accept only Doodocs-Signature.

Exactly one previous secret is kept, so a rotation is refused while another one’s window is still open. Wait for that window to close, or pass grace_seconds: 0 to cut over immediately, which also revokes a leaked secret at once.

Required scope: webhooks:manage

Error Codes:

WEBHOOK_NOT_FOUND: No such endpoint in the caller’s tenant.
DEVELOPER.WEBHOOK_ROTATION_IN_PROGRESS: A previous secret is still inside its grace window.

POST

developer

webhook_endpoints

{id}

_rotate_secret

Rotate Webhook Endpoint Secret

curl --request POST \
  --url https://app.doodocs.kz/api/developer/v1/webhook_endpoints/{id}/_rotate_secret \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "id": "<string>",
  "grace_seconds": 123
}
'

import requests

url = "https://app.doodocs.kz/api/developer/v1/webhook_endpoints/{id}/_rotate_secret"

payload = {
    "id": "<string>",
    "grace_seconds": 123
}
headers = {
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({id: '<string>', grace_seconds: 123})
};

fetch('https://app.doodocs.kz/api/developer/v1/webhook_endpoints/{id}/_rotate_secret', 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}/_rotate_secret",
  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([
    'id' => '<string>',
    'grace_seconds' => 123
  ]),
  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}/_rotate_secret"

	payload := strings.NewReader("{\n  \"id\": \"<string>\",\n  \"grace_seconds\": 123\n}")

	req, _ := http.NewRequest("POST", 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.post("https://app.doodocs.kz/api/developer/v1/webhook_endpoints/{id}/_rotate_secret")
  .header("X-API-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"id\": \"<string>\",\n  \"grace_seconds\": 123\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.doodocs.kz/api/developer/v1/webhook_endpoints/{id}/_rotate_secret")

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

request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"id\": \"<string>\",\n  \"grace_seconds\": 123\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>"
  },
  "secret": "<string>"
}

{
  "code": 123,
  "details": [
    {
      "@type": "<string>"
    }
  ],
  "message": "<string>"
}

Authorizations

X-API-Key

string

header

required

Path Parameters

string

required

Endpoint id (UUID) whose secret is rotated.

Body

application/json

string

required

Endpoint id (UUID) whose secret is rotated.

grace_seconds

integer<int32>

How long the previous secret keeps signing deliveries, in seconds. Omit for the 86400-second (24 hour) default. Pass 0 to drop the previous secret at once — the right choice when it leaked, because a graceful rotation leaves a leaked secret able to forge deliveries for the whole window.

Response

endpoint

object

The endpoint after rotation; previous_secret_expires_at bounds the window in which the old secret still signs deliveries.

Show child attributes

secret

string

read-only

The new signing secret. Shown once — store it now.

Rotate Webhook Endpoint Secret

curl --request POST \
  --url https://app.doodocs.kz/api/developer/v1/webhook_endpoints/{id}/_rotate_secret \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "id": "<string>",
  "grace_seconds": 123
}
'

import requests

url = "https://app.doodocs.kz/api/developer/v1/webhook_endpoints/{id}/_rotate_secret"

payload = {
    "id": "<string>",
    "grace_seconds": 123
}
headers = {
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({id: '<string>', grace_seconds: 123})
};

fetch('https://app.doodocs.kz/api/developer/v1/webhook_endpoints/{id}/_rotate_secret', 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}/_rotate_secret",
  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([
    'id' => '<string>',
    'grace_seconds' => 123
  ]),
  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}/_rotate_secret"

	payload := strings.NewReader("{\n  \"id\": \"<string>\",\n  \"grace_seconds\": 123\n}")

	req, _ := http.NewRequest("POST", 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.post("https://app.doodocs.kz/api/developer/v1/webhook_endpoints/{id}/_rotate_secret")
  .header("X-API-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"id\": \"<string>\",\n  \"grace_seconds\": 123\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.doodocs.kz/api/developer/v1/webhook_endpoints/{id}/_rotate_secret")

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

request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"id\": \"<string>\",\n  \"grace_seconds\": 123\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>"
  },
  "secret": "<string>"
}

{
  "code": 123,
  "details": [
    {
      "@type": "<string>"
    }
  ],
  "message": "<string>"
}

Overview

Endpoints

Rotate Webhook Endpoint Secret

Authorizations

Path Parameters

Body

Response