Skip to main content
Вместо опроса статуса подпишитесь на события: когда документ в вашем тенанте проходит очередной этап, Doodocs People сам отправит POST на ваш URL. Подписки управляются областью webhooks:manage — общий механизм разобран на странице Вебхуки.

Типы событий

События покрывают весь жизненный цикл — от отправки до завершения или обрыва.

Тонкий payload

Событие несёт тип, идентификатор документа и время — но не сам документ:
Актуальное состояние забирайте обычным запросом своим ключом:
Так к данным автоматически применяются область ключа и права владельца, а содержимое документа не уезжает на внешний URL. Доставка — «хотя бы один раз»: дедуплицируйте по полю id события.
Проверяйте подпись каждой доставки: заголовок Doodocs-Signature: t=<unix>,v1=<hex>, где v1 — это HMAC-SHA256(secret, "{t}.{тело}"). Как это сделать и отклонить просроченные доставки — на странице Вебхуки.
События документов доставляются по каждому документу тенанта — независимо от того, какие документы доступны владельцу endpoint по правам. Payload раскрывает только идентификатор и время смены статуса, но никогда не содержимое. Само содержимое остаётся за правами: перечитывание недоступного документа вернёт 404 DOCUMENT_NOT_FOUND (см. Обзор документов). Не считайте получение события подтверждением доступа к документу.

Дальше

Вебхуки

Подписка, проверка подписи и надёжность доставки.

Обзор документов

Статусы и структура объекта, который вы перечитываете.