Поделиться через

SignatureAPI

Отправляйте документы для подписывания, отслеживайте их ход выполнения и получите работу быстрее с помощью SignatureAPI, платформы электронной подписи, созданной для автоматизации. https://signatureapi.com/docs/integrations/power-automate/getting-started

Этот соединитель доступен в следующих продуктах и регионах:

Услуга Class Регионы
Copilot Studio Премия Все регионы Power Automate , кроме следующих:
     - Правительство США (GCC)
     - Правительство США (GCC High)
     — Облако Китая, управляемое 21Vianet
     - Министерство обороны США (DoD)
Логические приложения Стандарт Все регионы Logic Apps , кроме следующих:
     — Регионы Azure для государственных организаций
     — Регионы Azure Для Китая
     - Министерство обороны США (DoD)
Power Apps Премия Все регионы Power Apps , кроме следующих:
     - Правительство США (GCC)
     - Правительство США (GCC High)
     — Облако Китая, управляемое 21Vianet
     - Министерство обороны США (DoD)
Power Automate Премия Все регионы Power Automate , кроме следующих:
     - Правительство США (GCC)
     - Правительство США (GCC High)
     — Облако Китая, управляемое 21Vianet
     - Министерство обороны США (DoD)
Контакт
Имя API подписи, Inc.
URL https://signatureapi.com
Адрес электронной почты support@signatureapi.com
Метаданные соединителя
Publisher SignatureAPI
Website https://signatureapi.com/power-automate
Политика конфиденциальности https://signatureapi.com/privacy
Категории Сотрудничество; Продуктивность

SignatureAPI

SignatureAPI — это платформа электронной подписи, созданная для автоматизации.

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

Электронные подписи, сделанные с помощью SignatureAPI, являются юридически обязательными и глобально принятыми, как и традиционные рукописные подписи в большинстве юрисдикций.

SignatureAPI предлагает экономичное ценообразование для автоматизации больших объемов. Ознакомьтесь с нашими сведениями о ценах.

Ключевые функции

  • Несколько получателей: отправка документов в одну транзакцию до 10 пользователей.
  • Параллельная или последовательная подпись. Выберите отправку документов всем получателям одновременно или в определенном порядке.
  • Шаблоны документов: программное создание документов с помощью шаблонов и динамических данных.
  • Языки и локализация: настройте интерфейс подписывания с различными языками, форматами даты и времени и часовыми поясами.
  • Подписывание без учетной записи. Разрешить получателям подписывать документы без создания или входа в учетную запись.
  • Журнал аудита. Ведение подробного журнала доступа к документам, проверки и подписи событий.
  • Изменение правописания: обеспечение целостности документов с помощью проверенной, неотрекаемой подписи.
  • Отслеживание конвертов: отслеживайте ход подписывания с помощью пользовательской панели мониторинга.
  • Real-Time уведомления: получение мгновенных обновлений о действиях подписывания по электронной почте и веб-перехватчикам.

Предпосылки

Чтобы использовать этот соединитель, зарегистрируйтесь для учетной записи SignatureAPI и создайте ключ API. Получите бесплатный ключ API теста и настройте подключение.

Начало работы

Наиболее распространенный рабочий процесс включает отправку одного или нескольких документов получателям для подписи. Получатели получают сообщение электронной почты со ссылкой для доступа к интерфейсу подписи.

SignatureAPI поддерживает расширенные рабочие процессы. Ознакомьтесь с нашими руководствами по соединителям для пошаговые инструкции, варианты использования и стратегии автоматизации.

Шаг 1. Создание конверта

Начните с создания пустого конверта. Конверт — это контейнер, содержащий документы и управляющий процессом подписывания.

Возможные варианты:

Шаг 2. Добавление получателей

Укажите, кто должен подписать документы, добавив получателей в конверт. В настоящее время поддерживаются только пользователи, но в будущем будут доступны дополнительные типы получателей.

Шаг 3. Добавление документов

Добавьте документы, необходимые для подписей в конверт. Файлы PDF или DOCX можно отправить или создать документы из шаблонов с помощью данных.

Шаг 4. Определение мест в документах

Места — это области в документе, где получатель взаимодействует, например подписывание, предоставление инициалов или добавление текста. Они также могут содержать статические или вычисляемые значения, такие как даты завершения.

Шаг 5. Запуск процесса подписывания

После полной подготовки конверта инициируйте процесс подписывания.

Шаг 6. Дождитесь завершения конверта

Чтобы сохранить весь рабочий процесс в одном потоке, можно ждать завершения конверта. Это гарантирует, что все получатели подписаны и создается доставить (подписанный документ).

Кроме того, можно активировать отдельный рабочий процесс после завершения конверта и создания доставки.

Шаг 7. Получение подписанного документа

После завершения процесса получите подписанный документ (доставить).

Работа с триггерами

SignatureAPI предлагает триггеры для автоматизации рабочих процессов и упрощения процессов. Узнайте о полном списке триггеров и их использовании.

Часто используемые триггеры

При создании доставки

Активируется после завершения конверта и готово подписанный документ (доставить).

Когда получатель завершает конверт

Активируется каждый раз, когда получатель завершает процесс подписывания.

Когда сообщение электронной почты получателя отскочило

Активируется, когда адрес электронной почты получателя не может получить запрос.

Известные проблемы и ограничения

  • Используйте ключ тестового API для создания тестовых конвертов. Эти конверты не отправляют реальные сообщения электронной почты и не выставляются счета, что делает их идеальными для тестирования. Дополнительные сведения о тестовых конвертах.
  • Действие "Ожидание конверта" истекает через 30 дней. Если вы ожидаете, что получатели будут занимать больше времени, используйте новый рабочий процесс, начиная с триггера создания доставки.

Распространенные ошибки и решения

  • Убедитесь, что действие get a deliverable выполняется после действия "Ожидание конверта ". Доставка доступна только после того, как все получатели завершили свою часть.
  • При переходе с тестового ключа API на динамический ключ API обновите триггер, чтобы убедиться, что веб-перехватчик создается в правильной среде (live или test). Дополнительные сведения см. в нашем руководстве по устранению неполадок .

Создание подключения

Соединитель поддерживает следующие типы проверки подлинности:
По умолчанию Параметры для создания подключения. Все регионы Недоступен для совместного использования

По умолчанию

Применимо: все регионы

Параметры для создания подключения.

Это недоступно для общего доступа. Если приложение power предоставляется другому пользователю, пользователю будет предложено явно создать новое подключение.

Имя Тип Description Обязательно
Ключ API securestring Ключ API для учетной записи SignatureAPI. True

Ограничения регулирования

Имя Вызовы Период обновления
Вызовы API для каждого подключения 100 60 секунд

Действия

Добавление данных в шаблон

Добавляет данные в шаблон. https://signatureapi.com/docs/integrations/power-automate/actions/add-template-data
Добавление документа — DOCX

Добавляет документ DOCX в конверт. https://signatureapi.com/docs/integrations/power-automate/actions/add-document-docx
Добавление документа — PDF

Добавляет PDF-документ в конверт. https://signatureapi.com/docs/integrations/power-automate/actions/add-document
Добавление места — ввод текста

Добавляет в документ место ввода текста. https://signatureapi.com/docs/integrations/power-automate/actions/add-text-input-place
Добавление места — дата завершения конверта

Добавляет в документ место даты завершения конверта. https://signatureapi.com/docs/integrations/power-automate/actions/add-envelope-completed-date-place
Добавление места — дата завершения получателя

Добавляет получателю место даты завершения в документ. https://signatureapi.com/docs/integrations/power-automate/actions/add-recipient-completed-date-place
Добавление места — инициалы

Добавляет в документ инициалы. https://signatureapi.com/docs/integrations/power-automate/actions/add-initials-place
Добавление места — подпись

Добавляет место подписи в документ. https://signatureapi.com/docs/integrations/power-automate/actions/add-signature-place
Добавление места — текст

Добавляет текстовое место в документ. https://signatureapi.com/docs/integrations/power-automate/actions/add-text-place
Добавление получателя — подписыватель

Добавляет получателя в конверт. https://signatureapi.com/docs/integrations/power-automate/actions/add-recipient
Добавление шаблона — DOCX

Добавляет шаблон DOCX в конверт. https://signatureapi.com/docs/integrations/power-automate/actions/add-template
Дождитесь конверта

Ожидает, пока конверт достигнет завершенного состояния или другого окончательного состояния. https://signatureapi.com/docs/integrations/power-automate/actions/wait-envelope
Запуск конверта

Инициирует процесс подписывания для конверта. https://signatureapi.com/docs/integrations/power-automate/actions/start-envelope
Получение доставки

Извлекает доставить с помощью его идентификатора. Используйте его для скачивания подписанной копии конверта. https://signatureapi.com/docs/integrations/power-automate/actions/get-deliverable
Получение захваченного значения

Извлекает значение, введенное получателем во входном месте во время подписи. https://signatureapi.com/docs/integrations/power-automate/actions/get-capture
Получение конверта

Извлекает сведения о конверте по идентификатору. https://signatureapi.com/docs/integrations/power-automate/actions/get-envelope
Получение получателя

Извлекает сведения о получателе по идентификатору. https://signatureapi.com/docs/integrations/power-automate/actions/get-recipient
Создание конверта

Создает новый конверт, в который можно добавить получателей и документы. Когда все готово, используйте действие "Запуск конверта", чтобы инициировать процесс подписывания. https://signatureapi.com/docs/integrations/power-automate/actions/create-envelope
Создание церемонии — настраиваемая проверка подлинности

Создает церемонию, в которой получатель проходит проверку подлинности внешне в SignatureAPI. Используйте это для получения URL-адреса церемонии для совместного использования с получателями. Перед использованием пользовательской проверки подлинности https://signatureapi.com/docs/integrations/power-automate/actions/create-ceremony-custom
Создание церемонии — проверка подлинности по ссылке электронной почты

Создает церемонию, в которой получатель проходит проверку подлинности по ссылке, отправленной по электронной почте. https://signatureapi.com/docs/integrations/power-automate/actions/create-ceremony-email-link
Удаление конверта

Удаляет конверт и все связанные сведения. https://signatureapi.com/docs/integrations/power-automate/actions/delete-envelope

Добавление данных в шаблон

Идентификатор операции:
AddTemplateData

Добавляет данные в шаблон. https://signatureapi.com/docs/integrations/power-automate/actions/add-template-data

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор документа
 documentId True string

Идентификатор документа.
Имя поля
 field_name True string

Имя поля в шаблоне.
Ценность
 value True string

Значение поля в шаблоне.

Добавление документа — DOCX

Идентификатор операции:
AddDocumentDocx

Добавляет документ DOCX в конверт. https://signatureapi.com/docs/integrations/power-automate/actions/add-document-docx

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор конверта
 envelopeId True string

Идентификатор конверта.
Название документа
 title string

Заголовок этого документа. Это может отображаться получателям.
Содержимое файла
 file_content True byte

Содержимое файла документа.
Дополнительные свойства
 extra string

Дополнительные свойства для расширяемости

Возвращаемое значение

Тело
AddDocumentOutput

Добавление документа — PDF

Идентификатор операции:
AddDocument

Добавляет PDF-документ в конверт. https://signatureapi.com/docs/integrations/power-automate/actions/add-document

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор конверта
 envelopeId True string

Идентификатор конверта.
Название документа
 title string

Заголовок этого документа. Это может отображаться получателям.
Содержимое файла
 file_content True byte

Содержимое файла документа.
Дополнительные свойства
 extra string

Дополнительные свойства для расширяемости

Возвращаемое значение

Тело
AddDocumentOutput

Добавление места — ввод текста

Идентификатор операции:
AddPlaceTextInput

Добавляет в документ место ввода текста. https://signatureapi.com/docs/integrations/power-automate/actions/add-text-input-place

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор документа
 documentId True string

Идентификатор документа.
Поместите ключ
 key True string

Ключ, определяющий это место в документе.
Ключ получателя
 recipient_key True string

Ключ получателя, на который ссылается этот объект.
Запись как
 capture_as string

Ключ, который сохраняет входные данные получателя и включается в захват конверта.
Hint
 hint string

Сообщение подсказки, отображаемое по полю ввода для получателя.
Подсказка
 prompt string

Сообщение заполнителя, отображаемое внутри текстового поля ввода во время церемонии подписания.
Требование
 requirement string

Указывает, должен ли получатель заполнить это поле, чтобы завершить церемонию подписания.
Формат
 format string

Указывает допустимый формат ввода пользователем. Ознакомьтесь с документацией по допустимым значениям.
Форматирование сообщения
 format_message string

Сообщение отображается, когда входные данные пользователя не соответствуют требуемому формату.
Номер страницы
 page number

Номер страницы для размещения этого места.
Расстояние от верхней части
 top number

Расстояние (в точках) от верхней части страницы до нижней части места.
Расстояние от левого
 left number

Расстояние (в точках) от левой части страницы до места.
Дополнительные свойства
 extra string

Дополнительные свойства для расширяемости

Добавление места — дата завершения конверта

Идентификатор операции:
AddPlaceEnvelopeCompletedDate

Добавляет в документ место даты завершения конверта. https://signatureapi.com/docs/integrations/power-automate/actions/add-envelope-completed-date-place

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор документа
 documentId True string

Идентификатор документа.
Поместите ключ
 key True string

Ключ, определяющий это место в документе.
Формат даты
 date_format string

Определяет формат даты и времени. Ознакомьтесь с документацией по допустимым значениям.
Номер страницы
 page number

Номер страницы для размещения этого места.
Расстояние от верхней части
 top number

Расстояние (в точках) от верхней части страницы до нижней части места.
Расстояние от левого
 left number

Расстояние (в точках) от левой части страницы до места.
Дополнительные свойства
 extra string

Дополнительные свойства для расширяемости

Добавление места — дата завершения получателя

Идентификатор операции:
AddPlaceRecipientCompletedDate

Добавляет получателю место даты завершения в документ. https://signatureapi.com/docs/integrations/power-automate/actions/add-recipient-completed-date-place

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор документа
 documentId True string

Идентификатор документа.
Поместите ключ
 key True string

Ключ, определяющий это место в документе.
Ключ получателя
 recipient_key True string

Ключ получателя, на который ссылается этот объект.
Формат даты
 date_format string

Определяет формат даты и времени. Ознакомьтесь с документацией по допустимым значениям.
Номер страницы
 page number

Номер страницы для размещения этого места.
Расстояние от верхней части
 top number

Расстояние (в точках) от верхней части страницы до нижней части места.
Расстояние от левого
 left number

Расстояние (в точках) от левой части страницы до места.
Дополнительные свойства
 extra string

Дополнительные свойства для расширяемости

Добавление места — инициалы

Идентификатор операции:
AddPlaceInitials

Добавляет в документ инициалы. https://signatureapi.com/docs/integrations/power-automate/actions/add-initials-place

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор документа
 documentId True string

Идентификатор документа.
Поместите ключ
 key True string

Ключ, определяющий это место в документе.
Ключ получателя
 recipient_key True string

Ключ получателя, на который ссылается этот объект.
Высота места
 height number

Задайте настраиваемую высоту, ширина изменяется пропорционально.
Номер страницы
 page number

Номер страницы для размещения этого места.
Расстояние от верхней части
 top number

Расстояние (в точках) от верхней части страницы до нижней части места.
Расстояние от левого
 left number

Расстояние (в точках) от левой части страницы до места.
Дополнительные свойства
 extra string

Дополнительные свойства для расширяемости

Добавление места — подпись

Идентификатор операции:
AddPlaceSignature

Добавляет место подписи в документ. https://signatureapi.com/docs/integrations/power-automate/actions/add-signature-place

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор документа
 documentId True string

Идентификатор документа.
Поместите ключ
 key True string

Ключ, определяющий это место в документе.
Ключ получателя
 recipient_key True string

Ключ получателя, на который ссылается этот объект.
Высота места
 height number

Задайте настраиваемую высоту, ширина изменяется пропорционально.
Номер страницы
 page number

Номер страницы для размещения этого места.
Расстояние от верхней части
 top number

Расстояние (в точках) от верхней части страницы до нижней части места.
Расстояние от левого
 left number

Расстояние (в точках) от левой части страницы до места.
Дополнительные свойства
 extra string

Дополнительные свойства для расширяемости

Добавление места — текст

Идентификатор операции:
AddPlaceText

Добавляет текстовое место в документ. https://signatureapi.com/docs/integrations/power-automate/actions/add-text-place

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор документа
 documentId True string

Идентификатор документа.
Поместите ключ
 key True string

Ключ, определяющий это место в документе.
Ценность
 value True string

Значение этого текстового места.
Размер шрифта
 font_size number

Размер шрифта в точках.
Цвет шрифта
 font_color string

Цвет шрифта в шестнадцатеричной нотации.
Номер страницы
 page number

Номер страницы для размещения этого места.
Расстояние от верхней части
 top number

Расстояние (в точках) от верхней части страницы до нижней части места.
Расстояние от левого
 left number

Расстояние (в точках) от левой части страницы до места.
Дополнительные свойства
 extra string

Дополнительные свойства для расширяемости

Добавление получателя — подписыватель

Идентификатор операции:
AddRecipient

Добавляет получателя в конверт. https://signatureapi.com/docs/integrations/power-automate/actions/add-recipient

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор конверта
 envelopeId True string

Идентификатор конверта.
Имя получателя
 name True string

Имя получателя.
Электронная почта получателя
 email True string

Адрес электронной почты получателя.
Ключ получателя
 key True string

Ключ, определяющий получателя в конверте.
Создание церемонии получателя
 ceremony_creation string

Как создаются церемонии получателя.
Тип доставки получателя
 delivery_type string

Как доставка отправляется получателю.
Дополнительные свойства
 extra string

Дополнительные свойства для расширяемости

Возвращаемое значение

Тело
AddRecipientSignerOutput

Добавление шаблона — DOCX

Идентификатор операции:
AddTemplate

Добавляет шаблон DOCX в конверт. https://signatureapi.com/docs/integrations/power-automate/actions/add-template

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор конверта
 envelopeId True string

Идентификатор конверта.
Название документа
 title string

Заголовок этого документа. Это может отображаться получателям.
Содержимое файла
 file_content True byte

Содержимое файла документа.
Данные шаблона
 data array of string

Поле: пара значений, содержащая данные для заполнения шаблона.
Дополнительные свойства
 extra string

Дополнительные свойства для расширяемости

Возвращаемое значение

Тело
AddDocumentOutput

Дождитесь конверта

Идентификатор операции:
WaitEnvelope

Ожидает, пока конверт достигнет завершенного состояния или другого окончательного состояния. https://signatureapi.com/docs/integrations/power-automate/actions/wait-envelope

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор конверта
 envelopeId True string

Идентификатор конверта.

Возвращаемое значение

Тело
Envelope

Запуск конверта

Идентификатор операции:
StartEnvelope

Инициирует процесс подписывания для конверта. https://signatureapi.com/docs/integrations/power-automate/actions/start-envelope

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор конверта
 envelopeId True string

Идентификатор конверта.

Возвращаемое значение

Тело
StartEnvelopeOutput

Получение доставки

Идентификатор операции:
GetDeliverable

Извлекает доставить с помощью его идентификатора. Используйте его для скачивания подписанной копии конверта. https://signatureapi.com/docs/integrations/power-automate/actions/get-deliverable

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор доставки
 deliverableId True string

Идентификатор конечного результата.

Возвращаемое значение

Тело
Deliverable

Получение захваченного значения

Идентификатор операции:
GetCapture

Извлекает значение, введенное получателем во входном месте во время подписи. https://signatureapi.com/docs/integrations/power-automate/actions/get-capture

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор конверта
 envelopeId True string

Идентификатор конверта.
Ключ записи
 captureKey True string

Ключ захваченного значения.

Возвращаемое значение

Тело
Capture

Получение конверта

Идентификатор операции:
GetEnvelope

Извлекает сведения о конверте по идентификатору. https://signatureapi.com/docs/integrations/power-automate/actions/get-envelope

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор конверта
 envelopeId True string

Идентификатор конверта.

Возвращаемое значение

Тело
Envelope

Получение получателя

Идентификатор операции:
GetRecipient

Извлекает сведения о получателе по идентификатору. https://signatureapi.com/docs/integrations/power-automate/actions/get-recipient

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор получателя
 recipientId True string

Идентификатор получателя.

Возвращаемое значение

Тело
Recipient

Создание конверта

Идентификатор операции:
CreateEnvelope

Создает новый конверт, в который можно добавить получателей и документы. Когда все готово, используйте действие "Запуск конверта", чтобы инициировать процесс подписывания. https://signatureapi.com/docs/integrations/power-automate/actions/create-envelope

Параметры

Имя Ключ Обязательно Тип Описание
Название конверта
 title True string

Заголовок этого конверта. Это может отображаться получателям.
Метка конверта
 label string

Пользовательская метка, предоставленная конверту для упрощения идентификации. Метки предназначены для внутреннего использования и не отображаются получателям.
Сообщение конверта
 message string

Сообщение, которое будет отправлено получателям.
Режим конверта
 mode string

Конверты в режиме тестирования не являются привязками и не оплачиваются.
Маршрутизация конвертов
 routing string

Порядок, в котором получатели подписывают конверт. Он может быть параллельным, где все получатели могут подписывать одновременно или последовательно, где получатели подписываются друг за другом.
Language
 language string

Язык по умолчанию, используемый в церемонии подписания и доставки. Если он не указан, используется язык учетной записи по умолчанию. https://signatureapi.com/docs/localization/language
Часовой пояс
 timezone string

Часовой пояс, используемый для меток времени в конечных результатах. Если это не указано, используется смещение часового пояса учетной записи по умолчанию. https://signatureapi.com/docs/localization/timezone
Формат метки времени
 timestamp_format string

Формат даты и времени, используемый в метках времени для доставки. Если это не указано, используется формат метки времени учетной записи по умолчанию. https://signatureapi.com/docs/localization/timestamp_format
Аттестация конверта
 attestation string

Аттестация соответствия нормативным требованиям или нормативным требованиям
Имя
 name string

Имя отправителя.
Адрес электронной почты
 email string

Адрес электронной почты отправителя.
Разделы конверта
 topics array of string

Используется для классификации конвертов и фильтрации уведомлений веб-перехватчика.
Дополнительные свойства
 extra string

Дополнительные свойства для расширяемости

Возвращаемое значение

Тело
CreateEnvelopeOutput

Создание церемонии — настраиваемая проверка подлинности

Идентификатор операции:
CreateCeremonyCustom

Создает церемонию, в которой получатель проходит проверку подлинности внешне в SignatureAPI. Используйте это для получения URL-адреса церемонии для совместного использования с получателями. Перед использованием пользовательской проверки подлинности https://signatureapi.com/docs/integrations/power-automate/actions/create-ceremony-custom

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор получателя
 recipientId True string

Идентификатор получателя.
Поставщик проверки подлинности
 provider True string

Имя поставщика проверки подлинности. Это значение является произвольным и появится в журналах аудита конверта.
Данные проверки подлинности
 data True array of string

Ключ: пара значений, содержащая метаданные проверки подлинности. Эти сведения будут включены в журналы аудита конверта.
URL-адрес перенаправления
 redirect_url string

URL-адрес перенаправления получателя после завершения церемонии. Дополнительные сведения см. в следующем разделе: https://signatureapi.com/docs/resources/ceremonies/redirect-url
Дополнительные свойства
 extra string

Дополнительные свойства для расширяемости

Возвращаемое значение

Тело
CreateCeremonyCustomOutput

Создание церемонии — проверка подлинности по ссылке электронной почты

Идентификатор операции:
CreateCeremonyEmailLink

Создает церемонию, в которой получатель проходит проверку подлинности по ссылке, отправленной по электронной почте. https://signatureapi.com/docs/integrations/power-automate/actions/create-ceremony-email-link

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор получателя
 recipientId True string

Идентификатор получателя.
URL-адрес перенаправления
 redirect_url string

URL-адрес перенаправления получателя после завершения церемонии. Дополнительные сведения см. в следующем разделе: https://signatureapi.com/docs/resources/ceremonies/redirect-url
Дополнительные свойства
 extra string

Дополнительные свойства для расширяемости

Возвращаемое значение

response
object

Удаление конверта

Идентификатор операции:
DeleteEnvelope

Удаляет конверт и все связанные сведения. https://signatureapi.com/docs/integrations/power-automate/actions/delete-envelope

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор конверта
 envelopeId True string

Идентификатор конверта.

Триггеры

Если получатель завершается ошибкой

Это событие возникает, когда возникает сбой, связанный с получателем, что приводит к сбою состояния получателя.
Если получатель отклоняется

Это событие возникает, когда получатель отклоняет конверт.
Когда получатель завершится

Это событие возникает, когда получатель завершил свою часть процесса подписывания.
Когда получатель обижается

Это событие возникает, когда запрос обижается получателю.
Когда получатель освобождается

Это событие возникает, когда получатель готов отправить запрос на завершение конверта.
Когда получатель отправляется

Это событие возникает при отправке запроса получателю.
Когда получатель отскочил

Это событие возникает, когда сообщение электронной почты является неизменяемым, временно (обратимое отскочие) или постоянно (жесткое отскочие).
После завершения конверта

Это событие возникает при переходе состояния конверта с in_progress на завершение, указывая, что оно завершено всеми получателями.
При замене получателя

Это событие возникает, когда получатель заменяется новым.
При запуске конверта

Это событие происходит при переходе состояния конверта из обработки в in_progress, указывая, что оно готово к отправке получателям.
При отмене конверта

Это событие возникает, когда процесс подписывания был намеренно остановлен до завершения, что привело к отмене состояния конверта.
При сбое доставки

Это событие возникает при сбое создания доставки, что приводит к сбою состояния доставки.
При сбое конверта

Это событие возникает при сбое конверта, что приводит к сбою состояния конверта.
При создании доставки

Это событие возникает при успешном создании доставки, например журнала аудита.
При создании конверта

Это событие происходит всякий раз, когда создается конверт.

Если получатель завершается ошибкой

Идентификатор операции:
CreateEndpointForRecipientFailed

Это событие возникает, когда возникает сбой, связанный с получателем, что приводит к сбою состояния получателя.

Параметры

Имя Ключ Обязательно Тип Описание
Темы
 topics array of string

Используется для классификации конвертов и фильтрации уведомлений веб-перехватчика.

Возвращаемое значение

Тело
NotificationForRecipientFailed

Если получатель отклоняется

Идентификатор операции:
CreateEndpointForRecipientRejected

Это событие возникает, когда получатель отклоняет конверт.

Параметры

Имя Ключ Обязательно Тип Описание
Темы
 topics array of string

Используется для классификации конвертов и фильтрации уведомлений веб-перехватчика.

Возвращаемое значение

Тело
NotificationForRecipientRejected

Когда получатель завершится

Идентификатор операции:
CreateEndpointForRecipientCompleted

Это событие возникает, когда получатель завершил свою часть процесса подписывания.

Параметры

Имя Ключ Обязательно Тип Описание
Темы
 topics array of string

Используется для классификации конвертов и фильтрации уведомлений веб-перехватчика.

Возвращаемое значение

Тело
NotificationForRecipientCompleted

Когда получатель обижается

Идентификатор операции:
CreateEndpointForRecipientResent

Это событие возникает, когда запрос обижается получателю.

Параметры

Имя Ключ Обязательно Тип Описание
Темы
 topics array of string

Используется для классификации конвертов и фильтрации уведомлений веб-перехватчика.

Возвращаемое значение

Тело
NotificationForRecipientResent

Когда получатель освобождается

Идентификатор операции:
CreateEndpointForRecipientReleased

Это событие возникает, когда получатель готов отправить запрос на завершение конверта.

Параметры

Имя Ключ Обязательно Тип Описание
Темы
 topics array of string

Используется для классификации конвертов и фильтрации уведомлений веб-перехватчика.

Возвращаемое значение

Тело
NotificationForRecipientReleased

Когда получатель отправляется

Идентификатор операции:
CreateEndpointForRecipientSent

Это событие возникает при отправке запроса получателю.

Параметры

Имя Ключ Обязательно Тип Описание
Темы
 topics array of string

Используется для классификации конвертов и фильтрации уведомлений веб-перехватчика.

Возвращаемое значение

Тело
NotificationForRecipientSent

Когда получатель отскочил

Идентификатор операции:
CreateEndpointForRecipientBounced

Это событие возникает, когда сообщение электронной почты является неизменяемым, временно (обратимое отскочие) или постоянно (жесткое отскочие).

Параметры

Имя Ключ Обязательно Тип Описание
Темы
 topics array of string

Используется для классификации конвертов и фильтрации уведомлений веб-перехватчика.

Возвращаемое значение

Тело
NotificationForRecipientBounced

После завершения конверта

Идентификатор операции:
CreateEndpointForEnvelopeCompleted

Это событие возникает при переходе состояния конверта с in_progress на завершение, указывая, что оно завершено всеми получателями.

Параметры

Имя Ключ Обязательно Тип Описание
Темы
 topics array of string

Используется для классификации конвертов и фильтрации уведомлений веб-перехватчика.

Возвращаемое значение

Тело
NotificationForEnvelopeCompleted

При замене получателя

Идентификатор операции:
CreateEndpointForRecipientReplaced

Это событие возникает, когда получатель заменяется новым.

Параметры

Имя Ключ Обязательно Тип Описание
Темы
 topics array of string

Используется для классификации конвертов и фильтрации уведомлений веб-перехватчика.

Возвращаемое значение

Тело
NotificationForRecipientReplaced

При запуске конверта

Идентификатор операции:
CreateEndpointForEnvelopeStarted

Это событие происходит при переходе состояния конверта из обработки в in_progress, указывая, что оно готово к отправке получателям.

Параметры

Имя Ключ Обязательно Тип Описание
Темы
 topics array of string

Используется для классификации конвертов и фильтрации уведомлений веб-перехватчика.

Возвращаемое значение

Тело
NotificationForEnvelopeStarted

При отмене конверта

Идентификатор операции:
CreateEndpointForEnvelopeCanceled

Это событие возникает, когда процесс подписывания был намеренно остановлен до завершения, что привело к отмене состояния конверта.

Параметры

Имя Ключ Обязательно Тип Описание
Темы
 topics array of string

Используется для классификации конвертов и фильтрации уведомлений веб-перехватчика.

Возвращаемое значение

Тело
NotificationForEnvelopeCanceled

При сбое доставки

Идентификатор операции:
CreateEndpointForDeliverableFailed

Это событие возникает при сбое создания доставки, что приводит к сбою состояния доставки.

Параметры

Имя Ключ Обязательно Тип Описание
Темы
 topics array of string

Используется для классификации конвертов и фильтрации уведомлений веб-перехватчика.

Возвращаемое значение

Тело
NotificationForDeliverableFailed

При сбое конверта

Идентификатор операции:
CreateEndpointForEnvelopeFailed

Это событие возникает при сбое конверта, что приводит к сбою состояния конверта.

Параметры

Имя Ключ Обязательно Тип Описание
Темы
 topics array of string

Используется для классификации конвертов и фильтрации уведомлений веб-перехватчика.

Возвращаемое значение

Тело
NotificationForEnvelopeFailed

При создании доставки

Идентификатор операции:
CreateEndpointForDeliverableGenerated

Это событие возникает при успешном создании доставки, например журнала аудита.

Параметры

Имя Ключ Обязательно Тип Описание
Темы
 topics array of string

Используется для классификации конвертов и фильтрации уведомлений веб-перехватчика.

Возвращаемое значение

Тело
NotificationForDeliverableGenerated

При создании конверта

Идентификатор операции:
CreateEndpointForEnvelopeCreated

Это событие происходит всякий раз, когда создается конверт.

Параметры

Имя Ключ Обязательно Тип Описание
Темы
 topics array of string

Используется для классификации конвертов и фильтрации уведомлений веб-перехватчика.

Возвращаемое значение

Тело
NotificationForEnvelopeCreated

Определения

Конверт

Имя Путь Тип Описание
Идентификатор конверта
 id EnvelopeId

Идентификатор конверта.
Название конверта
 title EnvelopeTitle

Заголовок этого конверта. Это может отображаться получателям.
Метка конверта
 label EnvelopeLabel

Пользовательская метка, предоставленная конверту для упрощения идентификации. Метки предназначены для внутреннего использования и не отображаются получателям.
Сообщение конверта
 message EnvelopeMessage

Сообщение, которое будет отправлено получателям.
отправитель;
 sender EnvelopeSender
Состояние конверта
 status EnvelopeStatus

Состояние конверта.
Результата
 deliverable EnvelopeDeliverable
Конверт завершен по адресу
 completed_at EnvelopeCompletedAt

Время, когда все получатели завершили конверт.
Режим конверта
 mode EnvelopeMode

Конверты в режиме тестирования не являются привязками и не оплачиваются.
Маршрутизация конвертов
 routing EnvelopeRouting

Порядок, в котором получатели подписывают конверт. Он может быть параллельным, где все получатели могут подписывать одновременно или последовательно, где получатели подписываются друг за другом.
Часовой пояс
 timezone EnvelopeTimezone

Часовой пояс, используемый для меток времени в конечных результатах. Если это не указано, используется смещение часового пояса учетной записи по умолчанию. https://signatureapi.com/docs/localization/timezone
Формат метки времени
 timestamp_format EnvelopeTimestampFormat

Формат даты и времени, используемый в метках времени для доставки. Если это не указано, используется формат метки времени учетной записи по умолчанию. https://signatureapi.com/docs/localization/timestamp_format
Аттестация конверта
 attestation EnvelopeAttestation

Аттестация соответствия нормативным требованиям или нормативным требованиям
Разделы конверта
 topics EnvelopeTopics

Используется для классификации конвертов и фильтрации уведомлений веб-перехватчика.

Recipient

Имя Путь Тип Описание
Идентификатор получателя
 id RecipientId

Идентификатор получателя.
Идентификатор конверта
 envelope_id EnvelopeId

Идентификатор конверта.
Тип получателя
 type RecipientType

Тип получателя.
Ключ получателя
 key RecipientKey

Ключ, определяющий получателя в конверте.
Имя получателя
 name RecipientName

Имя получателя.
Электронная почта получателя
 email RecipientEmail

Адрес электронной почты получателя.
Состояние получателя
 status RecipientStatus

Состояние получателя.
Создание церемонии получателя
 ceremony_creation RecipientCeremonyCreation

Как создаются церемонии получателя.
Тип доставки получателя
 delivery_type RecipientDeliveryType

Как доставка отправляется получателю.
Получатель завершен по адресу
 completed_at RecipientCompletedAt

Время завершения конверта получателем.

Результата

Имя Путь Тип Описание
Идентификатор доставки
 id DeliverableId

Идентификатор конечного результата.
Тип доставки
 type DeliverableType

Тип доставки.
Состояние доставки
 status DeliverableStatus

Состояние доставки.
Содержимое файла
 file_content DeliverableFileContent

Содержимое файла доставки. Используйте его для сохранения подписанной копии конверта.

Capture

Имя Путь Тип Описание
Значение записи
 value CaptureValue

Значение записи входных данных получателя

CreateEnvelopeOutput

Имя Путь Тип Описание
Идентификатор конверта
 id EnvelopeId

Идентификатор конверта.
Название конверта
 title EnvelopeTitle

Заголовок этого конверта. Это может отображаться получателям.
Метка конверта
 label EnvelopeLabel

Пользовательская метка, предоставленная конверту для упрощения идентификации. Метки предназначены для внутреннего использования и не отображаются получателям.
Сообщение конверта
 message EnvelopeMessage

Сообщение, которое будет отправлено получателям.
отправитель;
 sender EnvelopeSender
Режим конверта
 mode EnvelopeMode

Конверты в режиме тестирования не являются привязками и не оплачиваются.
Маршрутизация конвертов
 routing EnvelopeRouting

Порядок, в котором получатели подписывают конверт. Он может быть параллельным, где все получатели могут подписывать одновременно или последовательно, где получатели подписываются друг за другом.
Часовой пояс
 timezone EnvelopeTimezone

Часовой пояс, используемый для меток времени в конечных результатах. Если это не указано, используется смещение часового пояса учетной записи по умолчанию. https://signatureapi.com/docs/localization/timezone
Формат метки времени
 timestamp_format EnvelopeTimestampFormat

Формат даты и времени, используемый в метках времени для доставки. Если это не указано, используется формат метки времени учетной записи по умолчанию. https://signatureapi.com/docs/localization/timestamp_format
Аттестация конверта
 attestation EnvelopeAttestation

Аттестация соответствия нормативным требованиям или нормативным требованиям
Разделы конверта
 topics EnvelopeTopics

Используется для классификации конвертов и фильтрации уведомлений веб-перехватчика.

StartEnvelopeOutput

Имя Путь Тип Описание
Состояние конверта
 status EnvelopeStatus

Состояние конверта.

AddDocumentOutput

Имя Путь Тип Описание
Идентификатор документа
 id DocumentId

Идентификатор документа

AddRecipientSignerOutput

Имя Путь Тип Описание
Идентификатор получателя
 id RecipientId

Идентификатор получателя.
Имя получателя
 name RecipientName

Имя получателя.
Электронная почта получателя
 email RecipientEmail

Адрес электронной почты получателя.
Ключ получателя
 key RecipientKey

Ключ, определяющий получателя в конверте.
Создание церемонии получателя
 ceremony_creation RecipientCeremonyCreation

Как создаются церемонии получателя.
Тип доставки получателя
 delivery_type RecipientDeliveryType

Как доставка отправляется получателю.

CreateCeremonyCustomOutput

Имя Путь Тип Описание
URL-адрес церемонии
 url CeremonyUrl

URL-адрес получателя должен посетить, чтобы инициировать церемонию

КонвертId

Идентификатор конверта.

Идентификатор конверта.

Идентификатор конверта
string

Конвертtitle

Заголовок этого конверта. Это может отображаться получателям.

Заголовок этого конверта. Это может отображаться получателям.

Название конверта
string

КонвертLabel

Пользовательская метка, предоставленная конверту для упрощения идентификации. Метки предназначены для внутреннего использования и не отображаются получателям.

Пользовательская метка, предоставленная конверту для упрощения идентификации. Метки предназначены для внутреннего использования и не отображаются получателям.

Метка конверта
string

КонвертMessage

Сообщение, которое будет отправлено получателям.

Сообщение, которое будет отправлено получателям.

Сообщение конверта
string

КонвертRouting

Порядок, в котором получатели подписывают конверт. Он может быть параллельным, где все получатели могут подписывать одновременно или последовательно, где получатели подписываются друг за другом.

Порядок, в котором получатели подписывают конверт. Он может быть параллельным, где все получатели могут подписывать одновременно или последовательно, где получатели подписываются друг за другом.

Маршрутизация конвертов
string

КонвертTimezone

Часовой пояс, используемый для меток времени в конечных результатах. Если это не указано, используется смещение часового пояса учетной записи по умолчанию. https://signatureapi.com/docs/localization/timezone

Часовой пояс, используемый для меток времени в конечных результатах. Если это не указано, используется смещение часового пояса учетной записи по умолчанию. https://signatureapi.com/docs/localization/timezone

Часовой пояс
string

КонвертTimestampFormat

Формат даты и времени, используемый в метках времени для доставки. Если это не указано, используется формат метки времени учетной записи по умолчанию. https://signatureapi.com/docs/localization/timestamp_format

Формат даты и времени, используемый в метках времени для доставки. Если это не указано, используется формат метки времени учетной записи по умолчанию. https://signatureapi.com/docs/localization/timestamp_format

Формат метки времени
string

Конверты

Имя Путь Тип Описание
Имя отправителя
 name string

Имя отправителя.
Электронная почта отправителя
 email string

Адрес электронной почты отправителя.

КонвертСтатус

Состояние конверта.

Состояние конверта.

Состояние конверта
string

КонвертMode

Конверты в режиме тестирования не являются привязками и не оплачиваются.

Конверты в режиме тестирования не являются привязками и не оплачиваются.

Режим конверта
string

КонвертTopics

Используется для классификации конвертов и фильтрации уведомлений веб-перехватчика.

Имя Путь Тип Описание
Товары
 string

КонвертAttestation

Аттестация соответствия нормативным требованиям или нормативным требованиям

Аттестация соответствия нормативным требованиям или нормативным требованиям

Аттестация конверта
string

КонвертDeliverable

Имя Путь Тип Описание
Идентификатор доставки
 id string

Идентификатор конечного результата. Используйте это для скачивания подписанной копии конверта.

КонвертCompletedAt

Время, когда все получатели завершили конверт.

Время, когда все получатели завершили конверт.

Конверт завершен по адресу
date-time

DocumentId

Идентификатор документа

Идентификатор документа

Идентификатор документа
string

RecipientId

Идентификатор получателя.

Идентификатор получателя.

Идентификатор получателя
string

RecipientType

Тип получателя.

Тип получателя.

Тип получателя
string

RecipientName

Имя получателя.

Имя получателя.

Имя получателя
string

RecipientEmail

Адрес электронной почты получателя.

Адрес электронной почты получателя.

Электронная почта получателя
string

RecipientKey

Ключ, определяющий получателя в конверте.

Ключ, определяющий получателя в конверте.

Ключ получателя
string

RecipientStatus

Состояние получателя.

Состояние получателя.

Состояние получателя
string

RecipientCeremonyCreation

Как создаются церемонии получателя.

Как создаются церемонии получателя.

Создание церемонии получателя
string

RecipientDeliveryType

Как доставка отправляется получателю.

Как доставка отправляется получателю.

Тип доставки получателя
string

RecipientCompletedAt

Время завершения конверта получателем.

Время завершения конверта получателем.

Получатель завершен по адресу
date-time

DeliverableId

Идентификатор конечного результата.

Идентификатор конечного результата.

Идентификатор доставки
string

DeliverableType

Тип доставки.

Тип доставки.

Тип доставки
string

DeliverableStatus

Состояние доставки.

Состояние доставки.

Состояние доставки
string

DeliverableFileContent

Содержимое файла доставки. Используйте его для сохранения подписанной копии конверта.

Содержимое файла доставки. Используйте его для сохранения подписанной копии конверта.

Содержимое файла
byte

ЦеремонииUrl

URL-адрес получателя должен посетить, чтобы инициировать церемонию

URL-адрес получателя должен посетить, чтобы инициировать церемонию

URL-адрес церемонии
string

CaptureValue

Значение записи входных данных получателя

Значение записи входных данных получателя

Значение записи
string

NotificationForEnvelopeCreated

Имя Путь Тип Описание
Идентификатор события
 id EventId

Идентификатор события.
Метка времени события
 timestamp EventTimestamp

Дата и время события в формате ISO 8601.
Тип события
 type EventType

тип события;
Идентификатор конверта
 data.envelope_id EventEnvelopeId

Идентификатор конверта, на который ссылается это событие.

NotificationForEnvelopeStarted

Имя Путь Тип Описание
Идентификатор события
 id EventId

Идентификатор события.
Метка времени события
 timestamp EventTimestamp

Дата и время события в формате ISO 8601.
Тип события
 type EventType

тип события;
Идентификатор конверта
 data.envelope_id EventEnvelopeId

Идентификатор конверта, на который ссылается это событие.

NotificationForEnvelopeCompleted

Имя Путь Тип Описание
Идентификатор события
 id EventId

Идентификатор события.
Метка времени события
 timestamp EventTimestamp

Дата и время события в формате ISO 8601.
Тип события
 type EventType

тип события;
Идентификатор конверта
 data.envelope_id EventEnvelopeId

Идентификатор конверта, на который ссылается это событие.

NotificationForEnvelopeFailed

Имя Путь Тип Описание
Идентификатор события
 id EventId

Идентификатор события.
Метка времени события
 timestamp EventTimestamp

Дата и время события в формате ISO 8601.
Тип события
 type EventType

тип события;
Идентификатор конверта
 data.envelope_id EventEnvelopeId

Идентификатор конверта, на который ссылается это событие.
Detail
 data.detail string

Сведения о сбое.

NotificationForEnvelopeCanceled

Имя Путь Тип Описание
Идентификатор события
 id EventId

Идентификатор события.
Метка времени события
 timestamp EventTimestamp

Дата и время события в формате ISO 8601.
Тип события
 type EventType

тип события;
Идентификатор конверта
 data.envelope_id EventEnvelopeId

Идентификатор конверта, на который ссылается это событие.

NotificationForRecipientReleased

Имя Путь Тип Описание
Идентификатор события
 id EventId

Идентификатор события.
Метка времени события
 timestamp EventTimestamp

Дата и время события в формате ISO 8601.
Тип события
 type EventType

тип события;
Идентификатор конверта
 data.envelope_id EventEnvelopeId

Идентификатор конверта, на который ссылается это событие.
Идентификатор получателя
 data.object_id EventRecipientId

Идентификатор получателя, на который ссылается это событие.
Тип получателя
 data.recipient_type EventRecipientType

Тип получателя, на который ссылается это событие.
Ключ получателя
 data.recipient_key EventRecipientKey

Ключ получателя, к этому событию относится.

NotificationForRecipientSent

Имя Путь Тип Описание
Идентификатор события
 id EventId

Идентификатор события.
Метка времени события
 timestamp EventTimestamp

Дата и время события в формате ISO 8601.
Тип события
 type EventType

тип события;
Идентификатор конверта
 data.envelope_id EventEnvelopeId

Идентификатор конверта, на который ссылается это событие.
Идентификатор получателя
 data.object_id EventRecipientId

Идентификатор получателя, на который ссылается это событие.
Тип получателя
 data.recipient_type EventRecipientType

Тип получателя, на который ссылается это событие.
Ключ получателя
 data.recipient_key EventRecipientKey

Ключ получателя, к этому событию относится.

NotificationForRecipientCompleted

Имя Путь Тип Описание
Идентификатор события
 id EventId

Идентификатор события.
Метка времени события
 timestamp EventTimestamp

Дата и время события в формате ISO 8601.
Тип события
 type EventType

тип события;
Идентификатор конверта
 data.envelope_id EventEnvelopeId

Идентификатор конверта, на который ссылается это событие.
Идентификатор получателя
 data.object_id EventRecipientId

Идентификатор получателя, на который ссылается это событие.
Тип получателя
 data.recipient_type EventRecipientType

Тип получателя, на который ссылается это событие.
Ключ получателя
 data.recipient_key EventRecipientKey

Ключ получателя, к этому событию относится.

NotificationForRecipientRejected

Имя Путь Тип Описание
Идентификатор события
 id EventId

Идентификатор события.
Метка времени события
 timestamp EventTimestamp

Дата и время события в формате ISO 8601.
Тип события
 type EventType

тип события;
Идентификатор конверта
 data.envelope_id EventEnvelopeId

Идентификатор конверта, на который ссылается это событие.
Идентификатор получателя
 data.object_id EventRecipientId

Идентификатор получателя, на который ссылается это событие.
Тип получателя
 data.recipient_type EventRecipientType

Тип получателя, на который ссылается это событие.
Ключ получателя
 data.recipient_key EventRecipientKey

Ключ получателя, к этому событию относится.
Причина
 data.reason string

Объяснение получателя об отказе.

NotificationForRecipientBounced

Имя Путь Тип Описание
Идентификатор события
 id EventId

Идентификатор события.
Метка времени события
 timestamp EventTimestamp

Дата и время события в формате ISO 8601.
Тип события
 type EventType

тип события;
Идентификатор конверта
 data.envelope_id EventEnvelopeId

Идентификатор конверта, на который ссылается это событие.
Идентификатор получателя
 data.object_id EventRecipientId

Идентификатор получателя, на который ссылается это событие.
Тип получателя
 data.recipient_type EventRecipientType

Тип получателя, на который ссылается это событие.
Ключ получателя
 data.recipient_key EventRecipientKey

Ключ получателя, к этому событию относится.
Detail
 data.detail string

Сведения о отскоке.

NotificationForRecipientFailed

Имя Путь Тип Описание
Идентификатор события
 id EventId

Идентификатор события.
Метка времени события
 timestamp EventTimestamp

Дата и время события в формате ISO 8601.
Тип события
 type EventType

тип события;
Идентификатор конверта
 data.envelope_id EventEnvelopeId

Идентификатор конверта, на который ссылается это событие.
Идентификатор получателя
 data.object_id EventRecipientId

Идентификатор получателя, на который ссылается это событие.
Тип получателя
 data.recipient_type EventRecipientType

Тип получателя, на который ссылается это событие.
Ключ получателя
 data.recipient_key EventRecipientKey

Ключ получателя, к этому событию относится.
Detail
 data.detail string

Сведения о сбое.

NotificationForRecipientReplaced

Имя Путь Тип Описание
Идентификатор события
 id EventId

Идентификатор события.
Метка времени события
 timestamp EventTimestamp

Дата и время события в формате ISO 8601.
Тип события
 type EventType

тип события;
Идентификатор конверта
 data.envelope_id EventEnvelopeId

Идентификатор конверта, на который ссылается это событие.
Идентификатор получателя
 data.object_id EventRecipientId

Идентификатор получателя, на который ссылается это событие.
Тип получателя
 data.recipient_type EventRecipientType

Тип получателя, на который ссылается это событие.
Ключ получателя
 data.recipient_key EventRecipientKey

Ключ получателя, к этому событию относится.
Новый идентификатор получателя
 data.new_recipient_id string

Идентификатор нового получателя.

NotificationForRecipientResent

Имя Путь Тип Описание
Идентификатор события
 id EventId

Идентификатор события.
Метка времени события
 timestamp EventTimestamp

Дата и время события в формате ISO 8601.
Тип события
 type EventType

тип события;
Идентификатор конверта
 data.envelope_id EventEnvelopeId

Идентификатор конверта, на который ссылается это событие.
Идентификатор получателя
 data.object_id EventRecipientId

Идентификатор получателя, на который ссылается это событие.
Тип получателя
 data.recipient_type EventRecipientType

Тип получателя, на который ссылается это событие.
Ключ получателя
 data.recipient_key EventRecipientKey

Ключ получателя, к этому событию относится.

NotificationForDeliverableGenerated

Имя Путь Тип Описание
Идентификатор события
 id EventId

Идентификатор события.
Метка времени события
 timestamp EventTimestamp

Дата и время события в формате ISO 8601.
Тип события
 type EventType

тип события;
Идентификатор конверта
 data.envelope_id EventEnvelopeId

Идентификатор конверта, на который ссылается это событие.
Идентификатор доставки
 data.object_id EventDeliverableId

Идентификатор доставить это событие ссылается.

NotificationForDeliverableFailed

Имя Путь Тип Описание
Идентификатор события
 id EventId

Идентификатор события.
Метка времени события
 timestamp EventTimestamp

Дата и время события в формате ISO 8601.
Тип события
 type EventType

тип события;
Идентификатор конверта
 data.envelope_id EventEnvelopeId

Идентификатор конверта, на который ссылается это событие.
Идентификатор доставки
 data.object_id EventDeliverableId

Идентификатор доставить это событие ссылается.
Detail
 data.detail string

Сведения о сбое.

EventId

Идентификатор события.

Идентификатор события.

Идентификатор события
string

ВремяСобытия

Дата и время события в формате ISO 8601.

Дата и время события в формате ISO 8601.

Метка времени события
date-time

Тип события

тип события;

тип события;

Тип события
string

EventEnvelopeId

Идентификатор конверта, на который ссылается это событие.

Идентификатор конверта, на который ссылается это событие.

Идентификатор конверта
string

EventRecipientId

Идентификатор получателя, на который ссылается это событие.

Идентификатор получателя, на который ссылается это событие.

Идентификатор получателя
string

EventRecipientType

Тип получателя, на который ссылается это событие.

Тип получателя, на который ссылается это событие.

Тип получателя
string

EventRecipientKey

Ключ получателя, к этому событию относится.

Ключ получателя, к этому событию относится.

Ключ получателя
string

EventDeliverableId

Идентификатор доставить это событие ссылается.

Идентификатор доставить это событие ссылается.

Идентификатор доставки
string

объект

Это тип object.