Partilhar via

AssinaturaAPI

Envie documentos para assinatura, acompanhe seu progresso e realize o trabalho mais rapidamente com a SignatureAPI, a plataforma de assinatura eletrônica criada para automação. https://signatureapi.com/docs/integrations/power-automate/getting-started

Este conector está disponível nos seguintes produtos e regiões:

Serviço Class Regiões
Estúdio Copiloto Premium Todas as regiões do Power Automatic , exceto as seguintes:
     - Governo dos EUA (CCG)
     - Governo dos EUA (GCC High)
     - China Cloud operado pela 21Vianet
     - Departamento de Defesa dos EUA (DoD)
Aplicações Lógicas Standard Todas as regiões do Logic Apps , exceto as seguintes:
     - Regiões do Azure Government
     - Regiões do Azure China
     - Departamento de Defesa dos EUA (DoD)
Aplicações Power Premium Todas as regiões do Power Apps , exceto as seguintes:
     - Governo dos EUA (CCG)
     - Governo dos EUA (GCC High)
     - China Cloud operado pela 21Vianet
     - Departamento de Defesa dos EUA (DoD)
Automatize o poder Premium Todas as regiões do Power Automatic , exceto as seguintes:
     - Governo dos EUA (CCG)
     - Governo dos EUA (GCC High)
     - China Cloud operado pela 21Vianet
     - Departamento de Defesa dos EUA (DoD)
Contato
Nome API de assinatura, Inc.
URL https://signatureapi.com
Email support@signatureapi.com
Metadados do conector
Editora AssinaturaAPI
Sítio Web https://signatureapi.com/power-automate
Política de privacidade https://signatureapi.com/privacy
Categorias Colaboração; Produtividade

AssinaturaAPI

SignatureAPI é uma plataforma de assinatura eletrônica criada para automação.

Envie documentos para assinatura e acompanhe seu progresso usando nossa plataforma de assinatura eletrônica para Power Automate, que fornece várias ações e gatilhos para ajudá-lo a criar fluxos de trabalho simples e complexos.

As assinaturas eletrônicas feitas com SignatureAPI são juridicamente vinculativas e globalmente aceitas, assim como as assinaturas de tinta tradicionais na maioria das jurisdições.

A SignatureAPI oferece preços econômicos para automação de alto volume. Consulte os nossos detalhes de preços.

Principais características

  • Vários destinatários: envie documentos para até 10 signatários em uma única transação.
  • Assinatura paralela ou sequencial: escolha enviar documentos para todos os destinatários de uma só vez ou em uma ordem específica.
  • Modelos de Documento: Gere documentos programaticamente usando modelos e dados dinâmicos.
  • Idiomas & Localização: Personalize a interface de assinatura com diferentes idiomas, formatos de data e hora e fusos horários.
  • Assinatura sem conta: permite que os destinatários assinem documentos sem criar ou fazer login em uma conta.
  • Log de auditoria: mantenha um log detalhado de eventos de acesso, revisão e assinatura de documentos.
  • Inviolabilidade: Garanta a integridade do documento com prova verificada e irrefutável pós-assinatura.
  • Rastrear envelopes: monitore o progresso da assinatura por meio de um painel fácil de usar.
  • Real-Time Notificações: Receba atualizações instantâneas sobre atividades de assinatura por e-mail e webhooks.

Pré-requisitos

Para usar esse conector, inscreva-se em uma conta SignatureAPI e gere uma chave de API. Obtenha uma chave de API de teste gratuita e configure sua conexão.

Introdução

O fluxo de trabalho mais comum envolve o envio de um ou mais documentos aos destinatários para assinatura. Os destinatários recebem um e-mail com um link para acessar a interface de assinatura.

SignatureAPI suporta fluxos de trabalho avançados. Explore nossos Guias de Conectores para obter instruções passo a passo, casos de uso e estratégias de automação.

Etapa 1: Criar um envelope

Comece criando um envelope vazio. Um envelope é um contêiner que contém documentos e gerencia o processo de assinatura.

As opções incluem:

Etapa 2: Adicionar destinatários

Especifique quem precisa assinar os documentos adicionando destinatários ao seu envelope. Atualmente, apenas signatários são suportados, mas tipos de destinatários adicionais estarão disponíveis no futuro.

Etapa 3: Adicionar documentos

Adicione os documentos que precisam de assinaturas ao envelope. Você pode carregar arquivos PDF ou DOCX ou gerar documentos a partir de modelos usando dados.

Etapa 4: Definir locais nos documentos

Os locais são áreas designadas dentro de um documento onde um destinatário interage, como assinar, fornecer iniciais ou adicionar texto. Eles também podem conter valores estáticos ou calculados, como datas de conclusão.

Etapa 5: Iniciar o processo de assinatura

Assim que o envelope estiver totalmente preparado, inicie o processo de assinatura.

Passo 6: Aguarde até que o envelope seja concluído

Para manter todo o fluxo de trabalho dentro do mesmo fluxo, você pode esperar até que o envelope seja concluído. Isso garante que todos os destinatários tenham assinado e que o produto final (documento assinado) seja gerado.

Como alternativa, você pode acionar um fluxo de trabalho separado quando o envelope for concluído e o resultado final for gerado.

Etapa 7: Recuperar o documento assinado

Quando o processo estiver concluído, recupere o documento assinado (entregue).

Trabalhando com gatilhos

A SignatureAPI oferece gatilhos para automatizar seus fluxos de trabalho e simplificar processos. Saiba mais sobre a lista completa de gatilhos e como usá-los.

Gatilhos comumente usados

Quando um produto final é gerado

Acionado quando o envelope é concluído e o documento assinado (entregue) está pronto.

Quando um destinatário preenche um envelope

Acionado sempre que um destinatário termina sua parte do processo de assinatura.

Quando um e-mail de destinatário é devolvido

Acionado quando o endereço de e-mail de um destinatário não pode receber a solicitação.

Problemas conhecidos e limitações

Erros e soluções comuns

  • Certifique-se de que a ação Obter um resultado final seja executada após a ação Aguardar envelope . Os resultados só estão disponíveis depois de todos os destinatários terem completado a sua parte.
  • Se você alternar de uma chave de API de teste para uma chave de API ativa, atualize o gatilho para garantir que o webhook seja criado no ambiente correto (ao vivo ou teste). Consulte nosso guia de solução de problemas para obter detalhes.

A criar uma ligação

O conector suporta os seguintes tipos de autenticação:
Predefinição Parâmetros para criar conexão. Todas as regiões Não compartilhável

Padrão

Aplicável: Todas as regiões

Parâmetros para criar conexão.

Esta conexão não é compartilhável. Se o aplicativo avançado for compartilhado com outro usuário, outro usuário será solicitado a criar uma nova conexão explicitamente.

Nome Tipo Description Obrigatório
Chave de API securestring A chave de API para sua conta SignatureAPI. Verdade

Limites de Limitação

Name Chamadas Período de Renovação
Chamadas de API por conexão 100 60 segundos

Ações

Adicionar dados ao modelo

Adiciona dados a um modelo. https://signatureapi.com/docs/integrations/power-automate/actions/add-template-data
Adicionar um destinatário — Signatário

Adiciona um destinatário a um envelope. https://signatureapi.com/docs/integrations/power-automate/actions/add-recipient
Adicionar um documento — DOCX

Adiciona um documento DOCX a um envelope. https://signatureapi.com/docs/integrations/power-automate/actions/add-document-docx
Adicionar um documento — PDF

Adiciona um documento PDF a um envelope. https://signatureapi.com/docs/integrations/power-automate/actions/add-document
Adicionar um local — Assinatura

Adiciona um local de assinatura a um documento. https://signatureapi.com/docs/integrations/power-automate/actions/add-signature-place
Adicionar um local — Data de conclusão do destinatário

Adiciona um local de data concluída do destinatário a um documento. https://signatureapi.com/docs/integrations/power-automate/actions/add-recipient-completed-date-place
Adicionar um local — Data de conclusão do envelope

Adiciona um local de data preenchido do envelope a um documento. https://signatureapi.com/docs/integrations/power-automate/actions/add-envelope-completed-date-place
Adicionar um local — Entrada de texto

Adiciona um local de entrada de texto a um documento. https://signatureapi.com/docs/integrations/power-automate/actions/add-text-input-place
Adicionar um local — Iniciais

Adiciona um local inicial a um documento. https://signatureapi.com/docs/integrations/power-automate/actions/add-initials-place
Adicionar um local — Texto

Adiciona um local de texto a um documento. https://signatureapi.com/docs/integrations/power-automate/actions/add-text-place
Adicionar um modelo — DOCX

Adiciona um modelo DOCX a um envelope. https://signatureapi.com/docs/integrations/power-automate/actions/add-template
Aguarde o envelope

Aguarda que um envelope atinja um estado concluído ou outro estado final. https://signatureapi.com/docs/integrations/power-automate/actions/wait-envelope
Criar um envelope

Cria um novo envelope ao qual você pode adicionar destinatários e documentos. Quando estiver pronto, use a ação 'Iniciar um envelope' para iniciar o processo de assinatura. https://signatureapi.com/docs/integrations/power-automate/actions/create-envelope
Criar uma cerimônia — Autenticação de link de e-mail

Cria uma cerimónia onde o destinatário é autenticado através de um link enviado para o seu e-mail. https://signatureapi.com/docs/integrations/power-automate/actions/create-ceremony-email-link
Criar uma cerimônia — Autenticação personalizada

Cria uma cerimônia em que o destinatário é autenticado externamente à SignatureAPI. Use isso para obter um URL de cerimônia para compartilhar com os destinatários. Antes de usar a autenticação personalizada, leia https://signatureapi.com/docs/integrations/power-automate/actions/create-ceremony-custom
Eliminar um envelope

Exclui um envelope e todas as informações associadas. https://signatureapi.com/docs/integrations/power-automate/actions/delete-envelope
Iniciar um envelope

Inicia o processo de assinatura de um envelope. https://signatureapi.com/docs/integrations/power-automate/actions/start-envelope
Obtenha um valor capturado

Recupera um valor inserido por um destinatário em um local de entrada durante a assinatura. https://signatureapi.com/docs/integrations/power-automate/actions/get-capture
Obtenha uma entrega

Recupera um produto final usando sua ID. Use-o para baixar uma cópia assinada do envelope. https://signatureapi.com/docs/integrations/power-automate/actions/get-deliverable
Obter um destinatário

Recupera os detalhes do destinatário pelo seu ID. https://signatureapi.com/docs/integrations/power-automate/actions/get-recipient
Obter um envelope

Recupera os detalhes do envelope pelo seu ID. https://signatureapi.com/docs/integrations/power-automate/actions/get-envelope

Adicionar dados ao modelo

ID da Operação:
AddTemplateData

Adiciona dados a um modelo. https://signatureapi.com/docs/integrations/power-automate/actions/add-template-data

Parâmetros

Name Chave Necessário Tipo Description
ID do documento
 documentId True string

A ID do documento.
Nome do campo
 field_name True string

O nome do campo no modelo.
Valor
 value True string

O valor para o campo no modelo.

Adicionar um destinatário — Signatário

ID da Operação:
AddRecipient

Adiciona um destinatário a um envelope. https://signatureapi.com/docs/integrations/power-automate/actions/add-recipient

Parâmetros

Name Chave Necessário Tipo Description
Envelope ID
 envelopeId True string

O ID do envelope.
Nome do destinatário
 name True string

O nome do destinatário.
E-mail do destinatário
 email True string

O endereço de e-mail do destinatário.
Chave do destinatário
 key True string

Uma chave que identifica um destinatário dentro de um envelope.
Criação da Cerimónia de Entrega dos Destinatários
 ceremony_creation string

Como as cerimônias para um destinatário são criadas.
Tipo de entrega do destinatário
 delivery_type string

Como o produto final é enviado ao destinatário.
Propriedades Extra
 extra string

Propriedades extras para extensibilidade

Devoluções

Body
AddRecipientSignerOutput

Adicionar um documento — DOCX

ID da Operação:
AddDocumentDocx

Adiciona um documento DOCX a um envelope. https://signatureapi.com/docs/integrations/power-automate/actions/add-document-docx

Parâmetros

Name Chave Necessário Tipo Description
Envelope ID
 envelopeId True string

O ID do envelope.
Título do documento
 title string

O título deste documento. Isso pode ser mostrado aos destinatários.
Conteúdo do Ficheiro
 file_content True byte

O conteúdo do ficheiro do documento.
Propriedades Extra
 extra string

Propriedades extras para extensibilidade

Devoluções

Body
AddDocumentOutput

Adicionar um documento — PDF

ID da Operação:
AddDocument

Adiciona um documento PDF a um envelope. https://signatureapi.com/docs/integrations/power-automate/actions/add-document

Parâmetros

Name Chave Necessário Tipo Description
Envelope ID
 envelopeId True string

O ID do envelope.
Título do documento
 title string

O título deste documento. Isso pode ser mostrado aos destinatários.
Conteúdo do Ficheiro
 file_content True byte

O conteúdo do ficheiro do documento.
Propriedades Extra
 extra string

Propriedades extras para extensibilidade

Devoluções

Body
AddDocumentOutput

Adicionar um local — Assinatura

ID da Operação:
AddPlaceSignature

Adiciona um local de assinatura a um documento. https://signatureapi.com/docs/integrations/power-automate/actions/add-signature-place

Parâmetros

Name Chave Necessário Tipo Description
ID do documento
 documentId True string

A ID do documento.
Chave do lugar
 key True string

Uma chave que identifica esse lugar dentro do documento.
Chave do destinatário
 recipient_key True string

A chave do destinatário a que este lugar se refere.
Altura do lugar
 height number

Defina uma altura personalizada, a largura ajusta-se proporcionalmente.
Número da página
 page number

O número da página para posicionar este lugar.
Distância do topo
 top number

A distância (em pontos) do topo da página para a parte inferior do lugar.
Distância da esquerda
 left number

A distância (em pontos) da esquerda da página para o local.
Propriedades Extra
 extra string

Propriedades extras para extensibilidade

Adicionar um local — Data de conclusão do destinatário

ID da Operação:
AddPlaceRecipientCompletedDate

Adiciona um local de data concluída do destinatário a um documento. https://signatureapi.com/docs/integrations/power-automate/actions/add-recipient-completed-date-place

Parâmetros

Name Chave Necessário Tipo Description
ID do documento
 documentId True string

A ID do documento.
Chave do lugar
 key True string

Uma chave que identifica esse lugar dentro do documento.
Chave do destinatário
 recipient_key True string

A chave do destinatário a que este lugar se refere.
Formato de data
 date_format string

Define o formato da data e hora. Consulte a documentação para obter os valores permitidos.
Número da página
 page number

O número da página para posicionar este lugar.
Distância do topo
 top number

A distância (em pontos) do topo da página para a parte inferior do lugar.
Distância da esquerda
 left number

A distância (em pontos) da esquerda da página para o local.
Propriedades Extra
 extra string

Propriedades extras para extensibilidade

Adicionar um local — Data de conclusão do envelope

ID da Operação:
AddPlaceEnvelopeCompletedDate

Adiciona um local de data preenchido do envelope a um documento. https://signatureapi.com/docs/integrations/power-automate/actions/add-envelope-completed-date-place

Parâmetros

Name Chave Necessário Tipo Description
ID do documento
 documentId True string

A ID do documento.
Chave do lugar
 key True string

Uma chave que identifica esse lugar dentro do documento.
Formato de data
 date_format string

Define o formato da data e hora. Consulte a documentação para obter os valores permitidos.
Número da página
 page number

O número da página para posicionar este lugar.
Distância do topo
 top number

A distância (em pontos) do topo da página para a parte inferior do lugar.
Distância da esquerda
 left number

A distância (em pontos) da esquerda da página para o local.
Propriedades Extra
 extra string

Propriedades extras para extensibilidade

Adicionar um local — Entrada de texto

ID da Operação:
AddPlaceTextInput

Adiciona um local de entrada de texto a um documento. https://signatureapi.com/docs/integrations/power-automate/actions/add-text-input-place

Parâmetros

Name Chave Necessário Tipo Description
ID do documento
 documentId True string

A ID do documento.
Chave do lugar
 key True string

Uma chave que identifica esse lugar dentro do documento.
Chave do destinatário
 recipient_key True string

A chave do destinatário a que este lugar se refere.
Capturar como
 capture_as string

Uma chave que armazena a entrada do destinatário e está incluída nas capturas do envelope.
Hint
 hint string

Uma mensagem de dica de ferramenta mostrada sobre o campo de entrada para o destinatário.
Pronta
 prompt string

Uma mensagem de espaço reservado mostrada dentro do campo de texto de entrada durante a cerimônia de assinatura.
Requisito
 requirement string

Especifica se o destinatário deve preencher este campo para concluir a cerimônia de assinatura.
Formato
 format string

Especifica o formato válido para entrada do usuário. Consulte a documentação para obter os valores permitidos.
Formatar mensagem
 format_message string

A mensagem exibida quando a entrada do usuário não corresponde ao formato necessário.
Número da página
 page number

O número da página para posicionar este lugar.
Distância do topo
 top number

A distância (em pontos) do topo da página para a parte inferior do lugar.
Distância da esquerda
 left number

A distância (em pontos) da esquerda da página para o local.
Propriedades Extra
 extra string

Propriedades extras para extensibilidade

Adicionar um local — Iniciais

ID da Operação:
AddPlaceInitials

Adiciona um local inicial a um documento. https://signatureapi.com/docs/integrations/power-automate/actions/add-initials-place

Parâmetros

Name Chave Necessário Tipo Description
ID do documento
 documentId True string

A ID do documento.
Chave do lugar
 key True string

Uma chave que identifica esse lugar dentro do documento.
Chave do destinatário
 recipient_key True string

A chave do destinatário a que este lugar se refere.
Altura do lugar
 height number

Defina uma altura personalizada, a largura ajusta-se proporcionalmente.
Número da página
 page number

O número da página para posicionar este lugar.
Distância do topo
 top number

A distância (em pontos) do topo da página para a parte inferior do lugar.
Distância da esquerda
 left number

A distância (em pontos) da esquerda da página para o local.
Propriedades Extra
 extra string

Propriedades extras para extensibilidade

Adicionar um local — Texto

ID da Operação:
AddPlaceText

Adiciona um local de texto a um documento. https://signatureapi.com/docs/integrations/power-automate/actions/add-text-place

Parâmetros

Name Chave Necessário Tipo Description
ID do documento
 documentId True string

A ID do documento.
Chave do lugar
 key True string

Uma chave que identifica esse lugar dentro do documento.
Valor
 value True string

O valor para este local de texto.
Tamanho do Tipo de Letra
 font_size number

O tamanho da fonte em pontos.
Cor da fonte
 font_color string

A cor da fonte em notação hexadecimal.
Número da página
 page number

O número da página para posicionar este lugar.
Distância do topo
 top number

A distância (em pontos) do topo da página para a parte inferior do lugar.
Distância da esquerda
 left number

A distância (em pontos) da esquerda da página para o local.
Propriedades Extra
 extra string

Propriedades extras para extensibilidade

Adicionar um modelo — DOCX

ID da Operação:
AddTemplate

Adiciona um modelo DOCX a um envelope. https://signatureapi.com/docs/integrations/power-automate/actions/add-template

Parâmetros

Name Chave Necessário Tipo Description
Envelope ID
 envelopeId True string

O ID do envelope.
Título do documento
 title string

O título deste documento. Isso pode ser mostrado aos destinatários.
Conteúdo do Ficheiro
 file_content True byte

O conteúdo do ficheiro do documento.
Dados do modelo
 data array of string

Campo: Par de valores contendo dados a serem preenchidos no modelo.
Propriedades Extra
 extra string

Propriedades extras para extensibilidade

Devoluções

Body
AddDocumentOutput

Aguarde o envelope

ID da Operação:
WaitEnvelope

Aguarda que um envelope atinja um estado concluído ou outro estado final. https://signatureapi.com/docs/integrations/power-automate/actions/wait-envelope

Parâmetros

Name Chave Necessário Tipo Description
Envelope ID
 envelopeId True string

O ID do envelope.

Devoluções

Body
Envelope

Criar um envelope

ID da Operação:
CreateEnvelope

Cria um novo envelope ao qual você pode adicionar destinatários e documentos. Quando estiver pronto, use a ação 'Iniciar um envelope' para iniciar o processo de assinatura. https://signatureapi.com/docs/integrations/power-automate/actions/create-envelope

Parâmetros

Name Chave Necessário Tipo Description
Título do envelope
 title True string

O título deste envelope. Isso pode ser mostrado aos destinatários.
Etiqueta do envelope
 label string

Etiqueta personalizada dada ao envelope para facilitar a identificação. As etiquetas são para uso interno e não são mostradas aos destinatários.
Mensagem de envelope
 message string

Uma mensagem que será enviada aos destinatários.
Modo de envelope
 mode string

Os envelopes do modo de teste não são vinculativos e não são faturados.
Roteamento de envelopes
 routing string

A ordem pela qual os destinatários assinam o envelope. Pode ser paralelo, onde todos os destinatários podem assinar simultaneamente, ou sequencial, onde os destinatários assinam um após o outro.
Linguagem
 language string

O idioma padrão a ser usado na cerimônia de assinatura e nos resultados. Se não for especificado, o idioma padrão da conta será usado. https://signatureapi.com/docs/localization/language
Fuso Horário
 timezone string

O fuso horário a ser usado para carimbos de data/hora em entregas. Se não for especificado, o deslocamento de fuso horário padrão da conta será usado. https://signatureapi.com/docs/localization/timezone
Formato de carimbo de data/hora
 timestamp_format string

O formato de data e hora a ser usado em carimbos de data/hora para entregas. Se não for especificado, o formato de carimbo de data/hora padrão da conta será usado. https://signatureapi.com/docs/localization/timestamp_format
Atestado de envelope
 attestation string

Atestado regulamentar ou de conformidade
Nome
 name string

O nome do remetente.
Email
 email string

O endereço de e-mail do remetente.
Tópicos do envelope
 topics array of string

Use para classificar envelopes e filtrar notificações de webhook.
Propriedades Extra
 extra string

Propriedades extras para extensibilidade

Devoluções

Body
CreateEnvelopeOutput
ID da Operação:
CreateCeremonyEmailLink

Cria uma cerimónia onde o destinatário é autenticado através de um link enviado para o seu e-mail. https://signatureapi.com/docs/integrations/power-automate/actions/create-ceremony-email-link

Parâmetros

Name Chave Necessário Tipo Description
ID do destinatário
 recipientId True string

O ID do destinatário.
URL de redirecionamento
 redirect_url string

Um URL para o qual redirecionar o destinatário após a conclusão de uma cerimônia. Saiba mais em: https://signatureapi.com/docs/resources/ceremonies/redirect-url
Propriedades Extra
 extra string

Propriedades extras para extensibilidade

Devoluções

response
object

Criar uma cerimônia — Autenticação personalizada

ID da Operação:
CreateCeremonyCustom

Cria uma cerimônia em que o destinatário é autenticado externamente à SignatureAPI. Use isso para obter um URL de cerimônia para compartilhar com os destinatários. Antes de usar a autenticação personalizada, leia https://signatureapi.com/docs/integrations/power-automate/actions/create-ceremony-custom

Parâmetros

Name Chave Necessário Tipo Description
ID do destinatário
 recipientId True string

O ID do destinatário.
Provedor de autenticação
 provider True string

O nome do provedor de autenticação. Esse valor é arbitrário e aparecerá nos logs de auditoria do envelope.
Dados de autenticação
 data True array of string

Chave: Par de valores que contém metadados de autenticação. Estes pormenores serão incluídos nos registos de auditoria do envelope.
URL de redirecionamento
 redirect_url string

Um URL para o qual redirecionar o destinatário após a conclusão de uma cerimônia. Saiba mais em: https://signatureapi.com/docs/resources/ceremonies/redirect-url
Propriedades Extra
 extra string

Propriedades extras para extensibilidade

Devoluções

Body
CreateCeremonyCustomOutput

Eliminar um envelope

ID da Operação:
DeleteEnvelope

Exclui um envelope e todas as informações associadas. https://signatureapi.com/docs/integrations/power-automate/actions/delete-envelope

Parâmetros

Name Chave Necessário Tipo Description
Envelope ID
 envelopeId True string

O ID do envelope.

Iniciar um envelope

ID da Operação:
StartEnvelope

Inicia o processo de assinatura de um envelope. https://signatureapi.com/docs/integrations/power-automate/actions/start-envelope

Parâmetros

Name Chave Necessário Tipo Description
Envelope ID
 envelopeId True string

O ID do envelope.

Devoluções

Body
StartEnvelopeOutput

Obtenha um valor capturado

ID da Operação:
GetCapture

Recupera um valor inserido por um destinatário em um local de entrada durante a assinatura. https://signatureapi.com/docs/integrations/power-automate/actions/get-capture

Parâmetros

Name Chave Necessário Tipo Description
Envelope ID
 envelopeId True string

O ID do envelope.
Chave de captura
 captureKey True string

A chave do valor capturado.

Devoluções

Body
Capture

Obtenha uma entrega

ID da Operação:
GetDeliverable

Recupera um produto final usando sua ID. Use-o para baixar uma cópia assinada do envelope. https://signatureapi.com/docs/integrations/power-automate/actions/get-deliverable

Parâmetros

Name Chave Necessário Tipo Description
ID do produto
 deliverableId True string

A ID do produto final.

Devoluções

Body
Deliverable

Obter um destinatário

ID da Operação:
GetRecipient

Recupera os detalhes do destinatário pelo seu ID. https://signatureapi.com/docs/integrations/power-automate/actions/get-recipient

Parâmetros

Name Chave Necessário Tipo Description
ID do destinatário
 recipientId True string

O ID do destinatário.

Devoluções

Body
Recipient

Obter um envelope

ID da Operação:
GetEnvelope

Recupera os detalhes do envelope pelo seu ID. https://signatureapi.com/docs/integrations/power-automate/actions/get-envelope

Parâmetros

Name Chave Necessário Tipo Description
Envelope ID
 envelopeId True string

O ID do envelope.

Devoluções

Body
Envelope

Acionadores

Quando um destinatário falha

Esse evento ocorre quando há uma falha relacionada a um destinatário, resultando em um status de destinatário de falha.
Quando um destinatário é concluído

Esse evento ocorre quando um destinatário concluiu sua parte do processo de assinatura.
Quando um destinatário é devolvido

Este evento ocorre quando um e-mail não pode ser entregue, seja temporariamente (soft-bounce) ou permanentemente (hard-bounce).
Quando um destinatário é enviado

Esse evento ocorre quando uma solicitação é enviada a um destinatário.
Quando um destinatário é liberado

Esse evento ocorre quando um destinatário está pronto para receber uma solicitação para preencher um envelope.
Quando um destinatário é reenviado

Esse evento ocorre quando uma solicitação é reenviada para um destinatário.
Quando um destinatário é rejeitado

Esse evento ocorre quando um destinatário rejeita o envelope.
Quando um destinatário é substituído

Esse evento ocorre quando um destinatário é substituído por um novo.
Quando um envelope falha

Esse evento ocorre quando um envelope falha, resultando em um status de envelope de falha.
Quando um envelope é cancelado

Esse evento ocorre quando o processo de assinatura foi intencionalmente interrompido antes da conclusão, resultando em um status de envelope cancelado.
Quando um envelope é criado

Esse evento ocorre sempre que um envelope é criado.
Quando um envelope é iniciado

Esse evento ocorre quando um status de envelope transita do processamento para o in_progress, indicando que ele está pronto para ser enviado aos destinatários.
Quando um envelope é preenchido

Esse evento ocorre quando um status de envelope transita de in_progress para concluído, indicando que foi concluído por todos os destinatários.
Quando um resultado final falha

Esse evento ocorre quando a geração de um produto final falha, resultando em um status de entrega de falha.
Quando um resultado final é gerado

Esse evento ocorre quando um resultado final, como um log de auditoria, é gerado com êxito.

Quando um destinatário falha

ID da Operação:
CreateEndpointForRecipientFailed

Esse evento ocorre quando há uma falha relacionada a um destinatário, resultando em um status de destinatário de falha.

Parâmetros

Name Chave Necessário Tipo Description
Tópicos
 topics array of string

Use para classificar envelopes e filtrar notificações de webhook.

Devoluções

Body
NotificationForRecipientFailed

Quando um destinatário é concluído

ID da Operação:
CreateEndpointForRecipientCompleted

Esse evento ocorre quando um destinatário concluiu sua parte do processo de assinatura.

Parâmetros

Name Chave Necessário Tipo Description
Tópicos
 topics array of string

Use para classificar envelopes e filtrar notificações de webhook.

Devoluções

Body
NotificationForRecipientCompleted

Quando um destinatário é devolvido

ID da Operação:
CreateEndpointForRecipientBounced

Este evento ocorre quando um e-mail não pode ser entregue, seja temporariamente (soft-bounce) ou permanentemente (hard-bounce).

Parâmetros

Name Chave Necessário Tipo Description
Tópicos
 topics array of string

Use para classificar envelopes e filtrar notificações de webhook.

Devoluções

Body
NotificationForRecipientBounced

Quando um destinatário é enviado

ID da Operação:
CreateEndpointForRecipientSent

Esse evento ocorre quando uma solicitação é enviada a um destinatário.

Parâmetros

Name Chave Necessário Tipo Description
Tópicos
 topics array of string

Use para classificar envelopes e filtrar notificações de webhook.

Devoluções

Body
NotificationForRecipientSent

Quando um destinatário é liberado

ID da Operação:
CreateEndpointForRecipientReleased

Esse evento ocorre quando um destinatário está pronto para receber uma solicitação para preencher um envelope.

Parâmetros

Name Chave Necessário Tipo Description
Tópicos
 topics array of string

Use para classificar envelopes e filtrar notificações de webhook.

Devoluções

Body
NotificationForRecipientReleased

Quando um destinatário é reenviado

ID da Operação:
CreateEndpointForRecipientResent

Esse evento ocorre quando uma solicitação é reenviada para um destinatário.

Parâmetros

Name Chave Necessário Tipo Description
Tópicos
 topics array of string

Use para classificar envelopes e filtrar notificações de webhook.

Devoluções

Body
NotificationForRecipientResent

Quando um destinatário é rejeitado

ID da Operação:
CreateEndpointForRecipientRejected

Esse evento ocorre quando um destinatário rejeita o envelope.

Parâmetros

Name Chave Necessário Tipo Description
Tópicos
 topics array of string

Use para classificar envelopes e filtrar notificações de webhook.

Devoluções

Body
NotificationForRecipientRejected

Quando um destinatário é substituído

ID da Operação:
CreateEndpointForRecipientReplaced

Esse evento ocorre quando um destinatário é substituído por um novo.

Parâmetros

Name Chave Necessário Tipo Description
Tópicos
 topics array of string

Use para classificar envelopes e filtrar notificações de webhook.

Devoluções

Body
NotificationForRecipientReplaced

Quando um envelope falha

ID da Operação:
CreateEndpointForEnvelopeFailed

Esse evento ocorre quando um envelope falha, resultando em um status de envelope de falha.

Parâmetros

Name Chave Necessário Tipo Description
Tópicos
 topics array of string

Use para classificar envelopes e filtrar notificações de webhook.

Devoluções

Body
NotificationForEnvelopeFailed

Quando um envelope é cancelado

ID da Operação:
CreateEndpointForEnvelopeCanceled

Esse evento ocorre quando o processo de assinatura foi intencionalmente interrompido antes da conclusão, resultando em um status de envelope cancelado.

Parâmetros

Name Chave Necessário Tipo Description
Tópicos
 topics array of string

Use para classificar envelopes e filtrar notificações de webhook.

Devoluções

Body
NotificationForEnvelopeCanceled

Quando um envelope é criado

ID da Operação:
CreateEndpointForEnvelopeCreated

Esse evento ocorre sempre que um envelope é criado.

Parâmetros

Name Chave Necessário Tipo Description
Tópicos
 topics array of string

Use para classificar envelopes e filtrar notificações de webhook.

Devoluções

Body
NotificationForEnvelopeCreated

Quando um envelope é iniciado

ID da Operação:
CreateEndpointForEnvelopeStarted

Esse evento ocorre quando um status de envelope transita do processamento para o in_progress, indicando que ele está pronto para ser enviado aos destinatários.

Parâmetros

Name Chave Necessário Tipo Description
Tópicos
 topics array of string

Use para classificar envelopes e filtrar notificações de webhook.

Devoluções

Body
NotificationForEnvelopeStarted

Quando um envelope é preenchido

ID da Operação:
CreateEndpointForEnvelopeCompleted

Esse evento ocorre quando um status de envelope transita de in_progress para concluído, indicando que foi concluído por todos os destinatários.

Parâmetros

Name Chave Necessário Tipo Description
Tópicos
 topics array of string

Use para classificar envelopes e filtrar notificações de webhook.

Devoluções

Body
NotificationForEnvelopeCompleted

Quando um resultado final falha

ID da Operação:
CreateEndpointForDeliverableFailed

Esse evento ocorre quando a geração de um produto final falha, resultando em um status de entrega de falha.

Parâmetros

Name Chave Necessário Tipo Description
Tópicos
 topics array of string

Use para classificar envelopes e filtrar notificações de webhook.

Devoluções

Body
NotificationForDeliverableFailed

Quando um resultado final é gerado

ID da Operação:
CreateEndpointForDeliverableGenerated

Esse evento ocorre quando um resultado final, como um log de auditoria, é gerado com êxito.

Parâmetros

Name Chave Necessário Tipo Description
Tópicos
 topics array of string

Use para classificar envelopes e filtrar notificações de webhook.

Devoluções

Body
NotificationForDeliverableGenerated

Definições

Envelope

Name Caminho Tipo Description
Envelope ID
 id EnvelopeId

O ID do envelope.
Título do envelope
 title EnvelopeTitle

O título deste envelope. Isso pode ser mostrado aos destinatários.
Etiqueta do envelope
 label EnvelopeLabel

Etiqueta personalizada dada ao envelope para facilitar a identificação. As etiquetas são para uso interno e não são mostradas aos destinatários.
Mensagem de envelope
 message EnvelopeMessage

Uma mensagem que será enviada aos destinatários.
remetente
 sender EnvelopeSender
Estado do envelope
 status EnvelopeStatus

O status do envelope.
Resultado final
 deliverable EnvelopeDeliverable
Envelope preenchido em
 completed_at EnvelopeCompletedAt

Hora em que todos os destinatários preencheram o envelope.
Modo de envelope
 mode EnvelopeMode

Os envelopes do modo de teste não são vinculativos e não são faturados.
Roteamento de envelopes
 routing EnvelopeRouting

A ordem pela qual os destinatários assinam o envelope. Pode ser paralelo, onde todos os destinatários podem assinar simultaneamente, ou sequencial, onde os destinatários assinam um após o outro.
Fuso Horário
 timezone EnvelopeTimezone

O fuso horário a ser usado para carimbos de data/hora em entregas. Se não for especificado, o deslocamento de fuso horário padrão da conta será usado. https://signatureapi.com/docs/localization/timezone
Formato de carimbo de data/hora
 timestamp_format EnvelopeTimestampFormat

O formato de data e hora a ser usado em carimbos de data/hora para entregas. Se não for especificado, o formato de carimbo de data/hora padrão da conta será usado. https://signatureapi.com/docs/localization/timestamp_format
Atestado de envelope
 attestation EnvelopeAttestation

Atestado regulamentar ou de conformidade
Tópicos do envelope
 topics EnvelopeTopics

Use para classificar envelopes e filtrar notificações de webhook.

Recipient

Name Caminho Tipo Description
ID do destinatário
 id RecipientId

O ID do destinatário.
Envelope ID
 envelope_id EnvelopeId

O ID do envelope.
Tipo de destinatário
 type RecipientType

O tipo do destinatário.
Chave do destinatário
 key RecipientKey

Uma chave que identifica um destinatário dentro de um envelope.
Nome do destinatário
 name RecipientName

O nome do destinatário.
E-mail do destinatário
 email RecipientEmail

O endereço de e-mail do destinatário.
Status do destinatário
 status RecipientStatus

O estatuto do destinatário.
Criação da Cerimónia de Entrega dos Destinatários
 ceremony_creation RecipientCeremonyCreation

Como as cerimônias para um destinatário são criadas.
Tipo de entrega do destinatário
 delivery_type RecipientDeliveryType

Como o produto final é enviado ao destinatário.
Destinatário Concluído em
 completed_at RecipientCompletedAt

Hora em que o destinatário preencheu o envelope.

Resultados tangíveis

Name Caminho Tipo Description
ID do produto
 id DeliverableId

A ID do produto final.
Tipo de produto
 type DeliverableType

O tipo de produto final.
Status da entrega
 status DeliverableStatus

O status do produto final.
Conteúdo do Ficheiro
 file_content DeliverableFileContent

O conteúdo do arquivo do produto final. Use-o para salvar uma cópia assinada do envelope.

Recolha

Name Caminho Tipo Description
Capturar valor
 value CaptureValue

O valor da captura de entrada do destinatário

CreateEnvelopeOutput

Name Caminho Tipo Description
Envelope ID
 id EnvelopeId

O ID do envelope.
Título do envelope
 title EnvelopeTitle

O título deste envelope. Isso pode ser mostrado aos destinatários.
Etiqueta do envelope
 label EnvelopeLabel

Etiqueta personalizada dada ao envelope para facilitar a identificação. As etiquetas são para uso interno e não são mostradas aos destinatários.
Mensagem de envelope
 message EnvelopeMessage

Uma mensagem que será enviada aos destinatários.
remetente
 sender EnvelopeSender
Modo de envelope
 mode EnvelopeMode

Os envelopes do modo de teste não são vinculativos e não são faturados.
Roteamento de envelopes
 routing EnvelopeRouting

A ordem pela qual os destinatários assinam o envelope. Pode ser paralelo, onde todos os destinatários podem assinar simultaneamente, ou sequencial, onde os destinatários assinam um após o outro.
Fuso Horário
 timezone EnvelopeTimezone

O fuso horário a ser usado para carimbos de data/hora em entregas. Se não for especificado, o deslocamento de fuso horário padrão da conta será usado. https://signatureapi.com/docs/localization/timezone
Formato de carimbo de data/hora
 timestamp_format EnvelopeTimestampFormat

O formato de data e hora a ser usado em carimbos de data/hora para entregas. Se não for especificado, o formato de carimbo de data/hora padrão da conta será usado. https://signatureapi.com/docs/localization/timestamp_format
Atestado de envelope
 attestation EnvelopeAttestation

Atestado regulamentar ou de conformidade
Tópicos do envelope
 topics EnvelopeTopics

Use para classificar envelopes e filtrar notificações de webhook.

StartEnvelopeOutput

Name Caminho Tipo Description
Estado do envelope
 status EnvelopeStatus

O status do envelope.

AddDocumentOutput

Name Caminho Tipo Description
ID do documento
 id DocumentId

O ID do documento

AddRecipientSignerOutput

Name Caminho Tipo Description
ID do destinatário
 id RecipientId

O ID do destinatário.
Nome do destinatário
 name RecipientName

O nome do destinatário.
E-mail do destinatário
 email RecipientEmail

O endereço de e-mail do destinatário.
Chave do destinatário
 key RecipientKey

Uma chave que identifica um destinatário dentro de um envelope.
Criação da Cerimónia de Entrega dos Destinatários
 ceremony_creation RecipientCeremonyCreation

Como as cerimônias para um destinatário são criadas.
Tipo de entrega do destinatário
 delivery_type RecipientDeliveryType

Como o produto final é enviado ao destinatário.

CreateCeremonyCustomOutput

Name Caminho Tipo Description
URL da cerimónia
 url CeremonyUrl

O URL que o destinatário deve visitar para iniciar a cerimónia

EnvelopeId

O ID do envelope.

O ID do envelope.

Envelope ID
string

EnvelopeTitle

O título deste envelope. Isso pode ser mostrado aos destinatários.

O título deste envelope. Isso pode ser mostrado aos destinatários.

Título do envelope
string

EnvelopeLabel

Etiqueta personalizada dada ao envelope para facilitar a identificação. As etiquetas são para uso interno e não são mostradas aos destinatários.

Etiqueta personalizada dada ao envelope para facilitar a identificação. As etiquetas são para uso interno e não são mostradas aos destinatários.

Etiqueta do envelope
string

EnvelopeMessage

Uma mensagem que será enviada aos destinatários.

Uma mensagem que será enviada aos destinatários.

Mensagem de envelope
string

EnvelopeRouting

A ordem pela qual os destinatários assinam o envelope. Pode ser paralelo, onde todos os destinatários podem assinar simultaneamente, ou sequencial, onde os destinatários assinam um após o outro.

A ordem pela qual os destinatários assinam o envelope. Pode ser paralelo, onde todos os destinatários podem assinar simultaneamente, ou sequencial, onde os destinatários assinam um após o outro.

Roteamento de envelopes
string

EnvelopeTimezone

O fuso horário a ser usado para carimbos de data/hora em entregas. Se não for especificado, o deslocamento de fuso horário padrão da conta será usado. https://signatureapi.com/docs/localization/timezone

O fuso horário a ser usado para carimbos de data/hora em entregas. Se não for especificado, o deslocamento de fuso horário padrão da conta será usado. https://signatureapi.com/docs/localization/timezone

Fuso Horário
string

EnvelopeTimestampFormat

O formato de data e hora a ser usado em carimbos de data/hora para entregas. Se não for especificado, o formato de carimbo de data/hora padrão da conta será usado. https://signatureapi.com/docs/localization/timestamp_format

O formato de data e hora a ser usado em carimbos de data/hora para entregas. Se não for especificado, o formato de carimbo de data/hora padrão da conta será usado. https://signatureapi.com/docs/localization/timestamp_format

Formato de carimbo de data/hora
string

EnvelopeSender

Name Caminho Tipo Description
Nome do remetente
 name string

O nome do remetente.
E-mail do remetente
 email string

O endereço de e-mail do remetente.

EnvelopeStatus

O status do envelope.

O status do envelope.

Estado do envelope
string

EnvelopeMode

Os envelopes do modo de teste não são vinculativos e não são faturados.

Os envelopes do modo de teste não são vinculativos e não são faturados.

Modo de envelope
string

EnvelopeTopics

Use para classificar envelopes e filtrar notificações de webhook.

Name Caminho Tipo Description
Itens
 string

Atestado de envelope

Atestado regulamentar ou de conformidade

Atestado regulamentar ou de conformidade

Atestado de envelope
string

EnvelopeDeliverable

Name Caminho Tipo Description
ID do produto
 id string

A ID do produto final. Use isso para baixar uma cópia assinada do envelope.

EnvelopeCompletedAt

Hora em que todos os destinatários preencheram o envelope.

Hora em que todos os destinatários preencheram o envelope.

Envelope preenchido em
date-time

ID do documento

O ID do documento

O ID do documento

ID do documento
string

ID do destinatário

O ID do destinatário.

O ID do destinatário.

ID do destinatário
string

Tipode Destinatário

O tipo do destinatário.

O tipo do destinatário.

Tipo de destinatário
string

Nome do destinatário

O nome do destinatário.

O nome do destinatário.

Nome do destinatário
string

DestinatárioE-mail

O endereço de e-mail do destinatário.

O endereço de e-mail do destinatário.

E-mail do destinatário
string

Chave de destinatário

Uma chave que identifica um destinatário dentro de um envelope.

Uma chave que identifica um destinatário dentro de um envelope.

Chave do destinatário
string

Status do destinatário

O estatuto do destinatário.

O estatuto do destinatário.

Status do destinatário
string

DestinatárioCerimôniaCriação

Como as cerimônias para um destinatário são criadas.

Como as cerimônias para um destinatário são criadas.

Criação da Cerimónia de Entrega dos Destinatários
string

RecipientDeliveryType

Como o produto final é enviado ao destinatário.

Como o produto final é enviado ao destinatário.

Tipo de entrega do destinatário
string

RecipientCompletedAt

Hora em que o destinatário preencheu o envelope.

Hora em que o destinatário preencheu o envelope.

Destinatário Concluído em
date-time

DeliverableId

A ID do produto final.

A ID do produto final.

ID do produto
string

DeliverableType

O tipo de produto final.

O tipo de produto final.

Tipo de produto
string

DeliverableStatus

O status do produto final.

O status do produto final.

Status da entrega
string

DeliverableFileContent

O conteúdo do arquivo do produto final. Use-o para salvar uma cópia assinada do envelope.

O conteúdo do arquivo do produto final. Use-o para salvar uma cópia assinada do envelope.

Conteúdo do Ficheiro
byte

CeremonyUrl

O URL que o destinatário deve visitar para iniciar a cerimónia

O URL que o destinatário deve visitar para iniciar a cerimónia

URL da cerimónia
string

Valor de Captura

O valor da captura de entrada do destinatário

O valor da captura de entrada do destinatário

Capturar valor
string

NotificationForEnvelopeCreated

Name Caminho Tipo Description
ID do Evento
 id EventId

A ID do evento.
Carimbo de data/hora do evento
 timestamp EventTimestamp

A data e hora do evento, no formato ISO 8601.
Tipo de Evento
 type EventType

O tipo de evento.
Envelope ID
 data.envelope_id EventEnvelopeId

A ID do envelope a que este evento se refere.

NotificationForEnvelopeStarted

Name Caminho Tipo Description
ID do Evento
 id EventId

A ID do evento.
Carimbo de data/hora do evento
 timestamp EventTimestamp

A data e hora do evento, no formato ISO 8601.
Tipo de Evento
 type EventType

O tipo de evento.
Envelope ID
 data.envelope_id EventEnvelopeId

A ID do envelope a que este evento se refere.

NotificationForEnvelopeCompleted

Name Caminho Tipo Description
ID do Evento
 id EventId

A ID do evento.
Carimbo de data/hora do evento
 timestamp EventTimestamp

A data e hora do evento, no formato ISO 8601.
Tipo de Evento
 type EventType

O tipo de evento.
Envelope ID
 data.envelope_id EventEnvelopeId

A ID do envelope a que este evento se refere.

NotificationForEnvelopeFailed

Name Caminho Tipo Description
ID do Evento
 id EventId

A ID do evento.
Carimbo de data/hora do evento
 timestamp EventTimestamp

A data e hora do evento, no formato ISO 8601.
Tipo de Evento
 type EventType

O tipo de evento.
Envelope ID
 data.envelope_id EventEnvelopeId

A ID do envelope a que este evento se refere.
Detail
 data.detail string

Informações sobre a falha.

NotificationForEnvelopeCanceled

Name Caminho Tipo Description
ID do Evento
 id EventId

A ID do evento.
Carimbo de data/hora do evento
 timestamp EventTimestamp

A data e hora do evento, no formato ISO 8601.
Tipo de Evento
 type EventType

O tipo de evento.
Envelope ID
 data.envelope_id EventEnvelopeId

A ID do envelope a que este evento se refere.

NotificationForRecipientReleased

Name Caminho Tipo Description
ID do Evento
 id EventId

A ID do evento.
Carimbo de data/hora do evento
 timestamp EventTimestamp

A data e hora do evento, no formato ISO 8601.
Tipo de Evento
 type EventType

O tipo de evento.
Envelope ID
 data.envelope_id EventEnvelopeId

A ID do envelope a que este evento se refere.
ID do destinatário
 data.object_id EventRecipientId

A ID do destinatário a que este evento se refere.
Tipo de destinatário
 data.recipient_type EventRecipientType

O tipo de destinatário a que este evento se refere.
Chave do destinatário
 data.recipient_key EventRecipientKey

A chave do destinatário a que este evento se refere.

NotificationForRecipientSent

Name Caminho Tipo Description
ID do Evento
 id EventId

A ID do evento.
Carimbo de data/hora do evento
 timestamp EventTimestamp

A data e hora do evento, no formato ISO 8601.
Tipo de Evento
 type EventType

O tipo de evento.
Envelope ID
 data.envelope_id EventEnvelopeId

A ID do envelope a que este evento se refere.
ID do destinatário
 data.object_id EventRecipientId

A ID do destinatário a que este evento se refere.
Tipo de destinatário
 data.recipient_type EventRecipientType

O tipo de destinatário a que este evento se refere.
Chave do destinatário
 data.recipient_key EventRecipientKey

A chave do destinatário a que este evento se refere.

NotificationForRecipientCompleted

Name Caminho Tipo Description
ID do Evento
 id EventId

A ID do evento.
Carimbo de data/hora do evento
 timestamp EventTimestamp

A data e hora do evento, no formato ISO 8601.
Tipo de Evento
 type EventType

O tipo de evento.
Envelope ID
 data.envelope_id EventEnvelopeId

A ID do envelope a que este evento se refere.
ID do destinatário
 data.object_id EventRecipientId

A ID do destinatário a que este evento se refere.
Tipo de destinatário
 data.recipient_type EventRecipientType

O tipo de destinatário a que este evento se refere.
Chave do destinatário
 data.recipient_key EventRecipientKey

A chave do destinatário a que este evento se refere.

NotificationForRecipientRejected

Name Caminho Tipo Description
ID do Evento
 id EventId

A ID do evento.
Carimbo de data/hora do evento
 timestamp EventTimestamp

A data e hora do evento, no formato ISO 8601.
Tipo de Evento
 type EventType

O tipo de evento.
Envelope ID
 data.envelope_id EventEnvelopeId

A ID do envelope a que este evento se refere.
ID do destinatário
 data.object_id EventRecipientId

A ID do destinatário a que este evento se refere.
Tipo de destinatário
 data.recipient_type EventRecipientType

O tipo de destinatário a que este evento se refere.
Chave do destinatário
 data.recipient_key EventRecipientKey

A chave do destinatário a que este evento se refere.
Reason
 data.reason string

A explicação do destinatário para a rejeição.

NotificationForRecipientBounced

Name Caminho Tipo Description
ID do Evento
 id EventId

A ID do evento.
Carimbo de data/hora do evento
 timestamp EventTimestamp

A data e hora do evento, no formato ISO 8601.
Tipo de Evento
 type EventType

O tipo de evento.
Envelope ID
 data.envelope_id EventEnvelopeId

A ID do envelope a que este evento se refere.
ID do destinatário
 data.object_id EventRecipientId

A ID do destinatário a que este evento se refere.
Tipo de destinatário
 data.recipient_type EventRecipientType

O tipo de destinatário a que este evento se refere.
Chave do destinatário
 data.recipient_key EventRecipientKey

A chave do destinatário a que este evento se refere.
Detail
 data.detail string

Informações sobre o salto.

NotificationForRecipientFailed

Name Caminho Tipo Description
ID do Evento
 id EventId

A ID do evento.
Carimbo de data/hora do evento
 timestamp EventTimestamp

A data e hora do evento, no formato ISO 8601.
Tipo de Evento
 type EventType

O tipo de evento.
Envelope ID
 data.envelope_id EventEnvelopeId

A ID do envelope a que este evento se refere.
ID do destinatário
 data.object_id EventRecipientId

A ID do destinatário a que este evento se refere.
Tipo de destinatário
 data.recipient_type EventRecipientType

O tipo de destinatário a que este evento se refere.
Chave do destinatário
 data.recipient_key EventRecipientKey

A chave do destinatário a que este evento se refere.
Detail
 data.detail string

Informações sobre a falha.

NotificationForRecipientReplaced

Name Caminho Tipo Description
ID do Evento
 id EventId

A ID do evento.
Carimbo de data/hora do evento
 timestamp EventTimestamp

A data e hora do evento, no formato ISO 8601.
Tipo de Evento
 type EventType

O tipo de evento.
Envelope ID
 data.envelope_id EventEnvelopeId

A ID do envelope a que este evento se refere.
ID do destinatário
 data.object_id EventRecipientId

A ID do destinatário a que este evento se refere.
Tipo de destinatário
 data.recipient_type EventRecipientType

O tipo de destinatário a que este evento se refere.
Chave do destinatário
 data.recipient_key EventRecipientKey

A chave do destinatário a que este evento se refere.
Novo ID de destinatário
 data.new_recipient_id string

A ID do novo destinatário.

NotificationForRecipientResent

Name Caminho Tipo Description
ID do Evento
 id EventId

A ID do evento.
Carimbo de data/hora do evento
 timestamp EventTimestamp

A data e hora do evento, no formato ISO 8601.
Tipo de Evento
 type EventType

O tipo de evento.
Envelope ID
 data.envelope_id EventEnvelopeId

A ID do envelope a que este evento se refere.
ID do destinatário
 data.object_id EventRecipientId

A ID do destinatário a que este evento se refere.
Tipo de destinatário
 data.recipient_type EventRecipientType

O tipo de destinatário a que este evento se refere.
Chave do destinatário
 data.recipient_key EventRecipientKey

A chave do destinatário a que este evento se refere.

NotificationForDeliverableGenerated

Name Caminho Tipo Description
ID do Evento
 id EventId

A ID do evento.
Carimbo de data/hora do evento
 timestamp EventTimestamp

A data e hora do evento, no formato ISO 8601.
Tipo de Evento
 type EventType

O tipo de evento.
Envelope ID
 data.envelope_id EventEnvelopeId

A ID do envelope a que este evento se refere.
ID do produto
 data.object_id EventDeliverableId

A ID do produto final a que este evento se refere.

NotificationForDeliverableFailed

Name Caminho Tipo Description
ID do Evento
 id EventId

A ID do evento.
Carimbo de data/hora do evento
 timestamp EventTimestamp

A data e hora do evento, no formato ISO 8601.
Tipo de Evento
 type EventType

O tipo de evento.
Envelope ID
 data.envelope_id EventEnvelopeId

A ID do envelope a que este evento se refere.
ID do produto
 data.object_id EventDeliverableId

A ID do produto final a que este evento se refere.
Detail
 data.detail string

Informações sobre a falha.

ID do Evento

A ID do evento.

A ID do evento.

ID do Evento
string

Marca temporal do evento

A data e hora do evento, no formato ISO 8601.

A data e hora do evento, no formato ISO 8601.

Carimbo de data/hora do evento
date-time

Tipo de Evento

O tipo de evento.

O tipo de evento.

Tipo de Evento
string

EventEnvelopeId

A ID do envelope a que este evento se refere.

A ID do envelope a que este evento se refere.

Envelope ID
string

EventRecipientId

A ID do destinatário a que este evento se refere.

A ID do destinatário a que este evento se refere.

ID do destinatário
string

EventRecipientType

O tipo de destinatário a que este evento se refere.

O tipo de destinatário a que este evento se refere.

Tipo de destinatário
string

EventRecipientKey

A chave do destinatário a que este evento se refere.

A chave do destinatário a que este evento se refere.

Chave do destinatário
string

EventDeliverableId

A ID do produto final a que este evento se refere.

A ID do produto final a que este evento se refere.

ID do produto
string

objecto

Este é o tipo 'objeto'.