Вебхуки
Каждое изменение состояния доставлено.
21 тип события. Подпись HMAC-SHA256. Доставка из надёжной очереди, а при сбое повторные попытки через растущие промежутки. Каждая попытка и её код ответа записываются.
Каталог событий.
Все события поступают из одной очереди доставки, с одинаковыми заголовками и одинаковой схемой подписи.
| Событие | Описание |
|---|---|
envelope.created | комплект создан |
envelope.sent | отправлено получателям |
envelope.opened | получатель открыл ссылку |
envelope.viewed_document | получатель просмотрел документ |
envelope.identity_verified | подписант прошёл проверку кодом |
envelope.field_filled | поле заполнено |
envelope.document_signed | документ подписан |
envelope.all_signed | все подписанты завершили |
envelope.document_completed | документ завершён |
envelope.completed | комплект завершён |
envelope.copied | копия отправлена получателю копии |
envelope.reminded | напоминание отправлено |
envelope.declined | подписант отказался |
envelope.expired | срок прошёл без подписи |
envelope.voided | отправитель отменил |
envelope.recalled | отправитель вернул в черновик |
envelope.id_verified | подписант прошёл проверку личности |
envelope.id_verification_failed | проверка личности не удалась |
envelope.recipient_updated | данные получателя изменены |
envelope.recipient_approved | получатель одобрил документ |
envelope.recipient_viewed | наблюдатель открыл документ |
Пример содержимого.
envelope.completed является самым частым событием. data содержит то, что записало соответствующее событие аудита, так что ключи зависят от типа события. Подпишитесь один раз; при сбое мы повторяем попытки через растущие промежутки, прежде чем отметить доставку как неудачную.
// Headers
X-VG-Signature: sha256=4c2a9bd3…71ff
X-VG-Delivery-Id: 8f4a2c1e-9b3d-4f02-a71c-2d5e6b8c0a19
// Body
{
"id": "8f4a2c1e-9b3d-4f02-a71c-2d5e6b8c0a19",
"event": "envelope.completed",
"envelope_id": "3f9c1d84-0b27-4a6e-9d51-7c2f8e4b1a03",
"workspace_id": "b41e7d90-5c38-42af-8e16-9a0d3f5c7b28",
"external_ref": "deal_142",
"timestamp": "2026-05-02T16:48:11.204Z",
"data": {
"recipient_id": "c72b5a10-8e64-4d39-b0f7-1e5a9c3d6482",
"actor_email": "signer@example.com",
"ip_address": "203.0.113.10",
"user_agent": "Mozilla/5.0 …",
"scope": "envelope"
}
}Гарантии доставки.
Подпись HMAC-SHA256
Каждая доставка содержит заголовок X-VG-Signature, дайджест HMAC-SHA256 необработанного тела запроса. Проверьте его, прежде чем доверять содержимому.
Повторные попытки
Доставку пробуют до 3 раз (повторы примерно через 1 и 5 минут), а затем отмечают как неудачную.
Записи о доставке
Каждая попытка и её код ответа записываются, так что причину неудачной доставки можно установить.
Идемпотентность по идентификатору доставки
Каждая доставка содержит заголовок X-VG-Delivery-Id, который повторяется как "id" в теле и не меняется между попытками. Сохраняйте его и пропускайте дубликаты.
Отправьте первый комплект бесплатно.
Начните с бесплатного плана и перейдите на «Про», когда его станет мало.