Почему в объекте DocuSignEnvelopeInformation отсутствует свойство «Дата аннулирования»?

Question

Я использую DocuSign REST API 3.0 для интеграции с моим приложением.

После аннулирования конверта DocuSign, если я вызываю EnvelopesApi.ListStatusChangesAsyn c, я получаю объект EnvelopesInformation, который показывает как VoidedDateTime, так и свойство VoidedReason. Это именно то, что мне нужно для обновления моей базы данных, но вся документация говорит мне, что я должен реализовать webhook для получения обновлений статуса вместо вызова API, поэтому я реализовал webhook.

Однако, когда DocuSign вызывает мой webhook после аннулирования конверта я получаю объект DocuSignEnvelopeInformation от DocuSign, который, по-видимому, не имеет свойства VoidedDateTime или Voided. Существует свойство VoidedReason, и есть свойства для других дат состояния, таких как Создано и Отправлено. Почему нет свойства Voided?

Что это означает, что после того, как webhook вызван (и обновляет мою базу данных с неполной информацией), мне все равно нужно вызвать API, чтобы получить VoidedDateTime в мою базу данных. Я просто потратил впустую свое время на реализацию веб-крюка? Или я что-то упустил?

Answer 1

Вы должны явно установить флажок Envelope Voided Reason в своей конфигурации Custom Connect. После выбора этого свойства вы сможете узнать причину, по которой этот конверт был аннулирован.

Webhook - это система уведомлений, где она уведомляет вашу Систему некоторыми данными / метаданными о конверте и, если эти данные кажутся недостаточными по вашему требованию вам нужно использовать API для извлечения остальных данных. Если Webhook недоступен, вам нужно выполнить механизм опроса, используя какой-то планировщик, чтобы продолжать опрашивать DocuSign после определенного интервала, который не выглядит хорошим дизайном и не очень масштабируемым. Таким образом, дизайн Webhook помогает вашей системе узнать, когда вызывать платформу DocuSign.

Обратите внимание, что, похоже, вы используете SOAP API, но я бы порекомендовал реализовать новую интеграцию API с DocuSign Rest API , поскольку он будет иметь новейшие функции, которые могут отсутствовать в SOAP API.