Вебхуки

Кожна зміна стану доставлена.

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 містить те, що записала відповідна подія аудиту, тож ключі залежать від типу події. Підпишіться один раз; у разі збою ми повторюємо спроби через зростаючі проміжки, перш ніж позначити доставку як невдалу.

POST → https://yourapp.com/hooks/vg-sign · envelope.completed
// 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" у тілі й не змінюється між спробами. Зберігайте його й пропускайте дублікати.

Надішліть перший комплект безкоштовно.

Почніть із безкоштовного плану й перейдіть на «Про», коли цього буде замало.