Vietnes karte
Latviešu
EUR €
JAUNS
Claude & ChatGPT — Ar pilnu jaudu.
Visi dokumenti · 409+ AI rīki · 30 sek iestatīšana
Claude· ChatGPT· Cursor· Gemini· +50
Pieslēgties tagad
Platforma
50+ AI moduļi un rīki
Risinājumi
Nozares, procesi, riski
Izstrādātājs
API, SDK, dokumentācija
Resursi
Pamācības, emuārs, atbalsts
Uzņēmums
Komanda, partneri, karjera
Cenas
Webhooki

Webhooki Notikumi reāllaikā

Ar HMAC parakstīti atgriezeniskie zvani katram dokumenta, uzdevuma, darbvietas un taska notikumam. 22 notikumu tipi, eksponenciāli atkārtojumi, ieteicams HTTPS.

22+
Notikumu tipi
<1s
Latence
HMAC
Parakstīts ar SHA-256
POST /jūsu-endpoint
Pieprasījuma galvenes
X-PaperOffice-Event: document.processed
X-PaperOffice-Event-ID: a3b7f9c1d4e8b2a6
X-PaperOffice-Signature: sha256=9f8a2c…
JSON ķermenis
{
  "event_type": "document.processed",
  "event_id": "a3b7f9c1d4e8b2a6",
  "timestamp": "2026-04-17T14:23:11Z",
  "subscription_id": 42,
  "data": { "pofid": "doc_01HZY8K3…" }
}
Paraksts verificēts HMAC-SHA256 · Notikuma ID reģistrēts

Uzticas vadošie uzņēmumi visā pasaulē

Pieejamie notikumi

22 notikumu tipi, grupēti pēc vienības

Abonējiet individuālus notikumus vai izmantojiet wildcards * visam.

Dokumenti

14
  • dokuments.augšupielādēts Jauns dokuments augšupielādēts darbvietā
  • dokuments.izveidots Alias priekš document.uploaded (saderībai)
  • dokuments.apstrādāts OCR/IDP cauruļvads veiksmīgi pabeigts
  • dokuments.rediģēts Metadati, birkas vai saturs atjaunināts
  • dokuments.dzēsts Dokuments pārvietots uz atkritni
  • dokuments.atjaunots Dokuments atgūts no atkritnes
  • dokuments.pārvietots Dokuments pārvietots starp darbvietām
  • dokuments.versija_izveidota Jauna versija pievienota esošam dokumentam
  • dokuments.dzīves_cikls_mainīts Saglabāšanas / arhivēšanas statuss mainīts
  • dokuments.komentārs_pievienots Komentārs publicēts dokumentam
  • dokuments.piezīme_pievienota Pievienota iekšēja piezīme
  • dokuments.birka_pievienota Dokumentam piešķirta birka
  • dokuments.juridiskā_saglabāšana_uzlikta Aktivēta juridiskā saglabāšana (nemaināma)
  • dokuments.juridiskā_saglabāšana_noņemta Juridiskā saglabāšana atcelta

Uzdevumi (Jobs)

3
  • uzdevums.pabeigts Asinhronais uzdevums veiksmīgi pabeigts
  • darbs.neizdevās Asinhronais uzdevums neizdevās termināli
  • darbs.progrese Progresa atjauninājums ilgstošu uzdevumu laikā

Darbvietas

2
  • darbvietas.koplietots Darbvietā koplietota ar lietotāju vai komandu
  • darbvietas.atcelts_koplietojums Darbvietas piekļuve atsaukta

Taski

3
  • uzdevums.izveidots Izveidots jauns taskis
  • uzdevums.pabeigts Taskis atzīmēts kā pabeigts
  • uzdevums.nokavēts Taskis pārsniedzis termiņu

Abonējiet ["*"], lai saņemtu katru jūsu konta notikumu.

Noderīgā daļa un galvenes

Katra piegāde seko vienai shēmai

Prognozējams JSON ķermenis, piecas parakstītas HTTP galvenes, ISO-8601 UTC laika zīmogi.

Pieprasījuma ķermenis (JSON)
{
  "event_type": "document.processed",
  "event_id": "a3b7f9c1d4e8b2a6c9f1d4e7b2a5c8f1",
  "timestamp": "2026-04-17T14:23:11Z",
  "subscription_id": 42,
  "data": {
    "pofid": "doc_01HZY8K3M7P2Q9R5T1V6W4X2Y8",
    "workspace_id": 17,
    "filename": "invoice-2026-04-17.pdf",
    "mime_type": "application/pdf",
    "size_bytes": 284521,
    "processing_result": {
      "ocr_done": true,
      "classification": "invoice",
      "confidence": 0.98
    }
  }
}
HTTP pieprasījuma galvenes
Satura-veids lietojums/json Vienmēr JSON, kodēts UTF-8
Lietotāja-aģents PaperOffice-Webhook/1.0 Fiksēts identifikators ugunsmūra atļauju sarakstiem
X-PaperOffice-Notikums dokuments.apstrādāts Piegādājamais notikuma tips
X-PaperOffice-Notikuma-ID a3b7f9c1… 128-bitu unikāls ID. Izmantot idempotencei.
X-PaperOffice-Abonementa-ID 42 Tā abonementa ID, kurš saņem notikumu
X-PaperOffice-Paraksts sha256=… Neapstrādāta ķermeņa HMAC-SHA256, kodēts heksadecimalā
Paraksta verifikācija

Verificēt katru piegādi ar HMAC-SHA256

Aprēķiniet HMAC-SHA256 pār neapstrādāto pieprasījuma ķermeni, izmantojot savu koplietojamo noslēpumu, pēc tam salīdziniet to ar X-PaperOffice-Signature, izmantojot salīdzināšanu ar konstantu laiku (hash_equals, crypto.timingSafeEqual).

import crypto from 'crypto';
import express from 'express';
const app = express();

const WEBHOOK_SECRET = process.env.PAPEROFFICE_WEBHOOK_SECRET;

app.post('/webhooks/paperoffice', express.raw({ type: 'application/json' }), (req, res) => {
  const signature = req.header('X-PaperOffice-Signature'); // "sha256=..."
  const eventId   = req.header('X-PaperOffice-Event-ID');
  const eventType = req.header('X-PaperOffice-Event');

  const expected = 'sha256=' + crypto
    .createHmac('sha256', WEBHOOK_SECRET)
    .update(req.body)
    .digest('hex');

  if (!signature || !crypto.timingSafeEqual(Buffer.from(signature), Buffer.from(expected))) {
    return res.status(401).send('invalid signature');
  }

  const event = JSON.parse(req.body.toString());
  // eventId als Idempotency-Key speichern -> gleiche ID nicht zweimal verarbeiten
  console.log(eventType, event.data);
  res.status(200).send('ok');
});
Atkārtots mēģinājums un piegāde

Trīs atkārtotu mēģinājumu stratēģijas, līdz 10 mēģinājumiem

Izvēlieties politiku katram abonementam. Katrs mēģinājums tiek reģistrēts ar statusa kodu, atbildes ķermeni un laiku.

linear

Lineārs

Fiksēts pieaugums: 30s, 60s, 90s, 120s, 150s…

none

Nav

Sūtīt un aizmirst. Nav atkārtotu mēģinājumu pat pie 5xx kļūdām. Noderīgi testa āķiem.

Veiksmīgi HTTP 2xx jūsu noildzes logā
Maks. atkārtoti mēģinājumi 0–10 mēģinājumi (noklusējums 5)
Noilde 1000–30000 ms uz mēģinājumu (noklusējums 10000)
Piegādes žurnāls Katrs mēģinājums tiek saglabāts webhook_deliveries auditam
Vadības API

9 beigu punkti zem /latest/webhooks/

Pilns CRUD abonementiem, piegādes žurnāliem, vienreizējiem darba abonementiem un testa beigu punkts — viss ar OAuth2 Bearer, viss MCP gatavs.

POST /webhooks/subscribe Izveidot jaunu abonementu (neierobežots uz kontu) po_webhooks_subscribe
GET /webhooks/list Uzskaitīt visus konta abonementus po_webhooks_list
POST /webhooks/update Atjaunināt esošu abonementu po_webhooks_update
POST /webhooks/delete Mīksti dzēst abonementu (piegādes žurnāls saglabāts) po_webhooks_delete
GET /webhooks/deliveries Iegūt piegādes žurnālu ar filtriem (event_type, success_only) po_webhooks_deliveries
POST /webhooks/test Nosūtīt test.ping notikumu, lai pārbaudītu piegādi po_webhooks_test
POST /webhooks/subscribe-job Vienreizējs āķis konkrētam job_id po_webhooks_subscribe_job
GET /webhooks/job-subscriptions Uzskaitīt ar darbu saistītos abonementus po_webhooks_job_subscriptions
GET /webhooks/info Pieejami notikumi, beigu punkti, atkārtotu mēģinājumu politikas, paraksta informācija po_webhooks_info
Enterprise drošība

Aizsargāts pēc dizaina

HMAC-SHA256

Katra krava parakstīta ar jūsu noslēpumu. Salīdzināšana ar konstantu laiku ir obligāta.

SSRF aizsardzība

Privātās / iekšējās IP adreses, localhost un mākoņa metadatu beigu punkti bloķēti abonēšanas un nosūtīšanas laikā.

Drošs pret DNS atkārtotu piesaisti

IP atkārtoti validēta nosūtīšanas laikā, fiksēta, izmantojot CURLOPT_RESOLVE.

HTTPS stingri ieteicams

http un https pieņemti. HTTPS ieteicams ražošanas videi.

Notikuma-ID idempotence

Katra piegāde satur unikālu X-PaperOffice-Event-ID. Veiciet deduplikāciju savā pusē.

Pilns audita ceļš

Visi mēģinājumi reģistrēti: statusa kods, atbildes ķermenis, laiks, kļūdas ziņojums.

Limiti

Neierobežoti abonementi, piegādes uzvedība pilnībā konfigurējama

Abonementi / konts
Aktīvi darba abonementi
10000 ms
Noklusējuma noilde
5
Noklusējuma maks. atkārtoti mēģinājumi

Pieejams visos tarifu plānos. Maksā par lietojumu: 1 kredīts par veiksmīgu piegādi (HTTP 2xx). Atkārtoti mēģinājumi, testa notikumi un neizdevušās piegādes ir bezmaksas.

Sākt tagad

Jūsu pirmais āķis 60 sekundēs

Izveidojiet beigu punktu, abonējiet, izmantojot API, palaidiet testa notikumu. Tas ir viss.

HMAC-SHA256 Eksponenciāla aizkave Pilns audita ceļš