Create Webhook Endpoint

POST

developer

webhook_endpoints

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

import requests

url = "https://app.doodocs.kz/api/developer/v1/webhook_endpoints"

payload = {
    "event_types": ["<string>"],
    "url": "<string>"
}
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({event_types: ['<string>'], url: '<string>'})
};

fetch('https://app.doodocs.kz/api/developer/v1/webhook_endpoints', 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",
  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([
    '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"

	payload := strings.NewReader("{\n  \"event_types\": [\n    \"<string>\"\n  ],\n  \"url\": \"<string>\"\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")
  .header("X-API-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\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")

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  \"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>"
  },
  "secret": "<string>"
}

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

Authorizations

X-API-Key

string

header

required

Body

application/json

event_types

string[]

required

Event types to deliver. Employee/person: employee.changed, employee.deleted, person.changed — a change to identity fields (name, IIN) emits ONLY person.changed (subscribe to it to receive renames), while employee.changed covers employment attributes (department, position, status). Document lifecycle: document.sent, document.approval_started, document.signing_started, document.completed, document.rejected, document.revoked, document.change_requested, document.deleted. Employee/person payloads carry {employee_id}; document payloads carry {document_id}. Refetch the resource with your own key. Note: document events are delivered for every document in the tenant regardless of the endpoint owner's per-document permissions — payloads reveal a document's id and lifecycle timing (never its content; GetDocument still enforces access). Do not subscribe if the mere existence or timing of confidential documents must stay hidden from the endpoint owner.

url

string

required

Delivery target. Must be https. A host that resolves to a private or loopback address is accepted here but blocked at delivery time, so every attempt would fail.

Response

endpoint

object

The created endpoint.

Show child attributes

secret

string

read-only

Signing secret. Shown once — store it to verify delivery signatures.

Create Webhook Endpoint

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

import requests

url = "https://app.doodocs.kz/api/developer/v1/webhook_endpoints"

payload = {
    "event_types": ["<string>"],
    "url": "<string>"
}
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({event_types: ['<string>'], url: '<string>'})
};

fetch('https://app.doodocs.kz/api/developer/v1/webhook_endpoints', 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",
  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([
    '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"

	payload := strings.NewReader("{\n  \"event_types\": [\n    \"<string>\"\n  ],\n  \"url\": \"<string>\"\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")
  .header("X-API-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\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")

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  \"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>"
  },
  "secret": "<string>"
}

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

Overview

Endpoints

Authorizations

Body

Response