SignatureAPI
Envie documentos para assinatura, acompanhe seu progresso e faça o trabalho mais rapidamente com o SignatureAPI, a plataforma de assinatura eletrônica criada para automação. https://signatureapi.com/docs/integrations/power-automate/getting-started
Esse conector está disponível nos seguintes produtos e regiões:
| Service | Class | Regions |
|---|---|---|
| Copilot Studio | Premium | Todas as regiões do Power Automate , exceto as seguintes: – Governo dos EUA (GCC) – Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Aplicativos Lógicos | Standard | Todas as regiões dos Aplicativos Lógicos , exceto as seguintes: – Regiões do Azure Governamental - Regiões do Azure China - Departamento de Defesa dos EUA (DoD) |
| Power Apps | Premium | Todas as regiões do Power Apps , exceto as seguintes: – Governo dos EUA (GCC) – Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Power Automate | Premium | Todas as regiões do Power Automate , exceto as seguintes: – Governo dos EUA (GCC) – 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 |
| support@signatureapi.com |
| Metadados do conector | |
|---|---|
| Publicador | SignatureAPI |
| Site | https://signatureapi.com/power-automate |
| Política de privacidade | https://signatureapi.com/privacy |
| Categorias | Colaboração; Produtividade |
SignatureAPI
SignatureAPI é uma plataforma de assinatura eletrônica criada para automação.
Envie documentos para assinatura e acompanhe seu progresso usando nossa plataforma de assinatura e para o 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 legalmente vinculativas e aceitas globalmente, assim como as assinaturas de tinta tradicionais na maioria das jurisdições.
O SignatureAPI oferece preços econômicos para automação de alto volume. Confira nossos detalhes de preços.
Principais características
- Vários Destinatários: enviar documentos para até 10 signatários em uma única transação.
- Assinatura paralela ou sequencial: opte por enviar documentos a todos os destinatários de uma 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: permitir que os destinatários assinem documentos sem criar ou fazer logon em uma conta.
- Log de Auditoria: mantenha um log detalhado de eventos de acesso, revisão e assinatura do documento.
- Revisão de adulteração: verifique a integridade do documento com a prova verificada e irrefutável após a assinatura.
- Acompanhar envelopes: monitorar o progresso da assinatura por meio de um painel amigável.
- Real-Time Notificações: receba atualizações instantâneas sobre atividades de assinatura por email 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 para destinatários para assinatura. Os destinatários recebem um email com um link para acessar a interface de assinatura.
O SignatureAPI dá suporte a fluxos de trabalho avançados. Explore nossos Guias do Conector 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:
- Definindo se os destinatários entrarão em paralelo ou sequencialmente (roteamento de destinatário)
- Personalizando o idioma, o fuso horário e o formato de data e hora (localização do envelope)
- Definindo o nome e o email do remetente
Etapa 2: Adicionar Destinatários
Especifique quem precisa assinar os documentos adicionando destinatários ao envelope. Atualmente, somente os signatários têm suporte, mas os tipos de destinatário 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 de modelos usando dados.
- Ação: Adicionar um documento — PDF
- Ação: Adicionar um documento — DOCX
- Ação: Adicionar um modelo — DOCX
- Saiba mais sobre modelos
Etapa 4: Definir locais nos documentos
Os locais são áreas designadas em um documento em que um destinatário interage, como assinatura, fornecimento de iniciais ou adição de texto. Eles também podem conter valores estáticos ou calculados, como datas de conclusão.
- Ação: Adicionar um local — Assinatura
- Ação: Adicionar um local — Iniciais
- Ação: Adicionar um local — Entrada de texto
- Ação: Adicionar um local — Texto
- Ação: Adicionar um local — Data de conclusão do destinatário
- Ação: Adicionar um local — Data de conclusão do envelope
Etapa 5: Iniciar o processo de assinatura
Depois que o envelope estiver totalmente preparado, inicie o processo de assinatura.
Etapa 6: Aguardar a conclusão do envelope
Para manter todo o fluxo de trabalho dentro do mesmo fluxo, você pode aguardar até que o envelope seja concluído. Isso garante que todos os destinatários tenham assinado e que o documento entregue (assinado) seja gerado.
Como alternativa, você pode disparar um fluxo de trabalho separado quando o envelope é concluído e o resultado é gerado.
Etapa 7: Recuperar o documento assinado
Depois que o processo for concluído, recupere o documento assinado (entregue).
Trabalhando com gatilhos
O 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 deliverable é gerado
Disparado quando o envelope é concluído e o documento assinado (entregue) está pronto.
Quando um destinatário conclui um envelope
Disparado sempre que um destinatário conclui sua parte do processo de assinatura.
Quando um email do destinatário é enviado de volta
Disparado quando o endereço de email de um destinatário não pode receber a solicitação.
Problemas e limitações conhecidos
- Use uma chave de API de teste para criar envelopes de teste. Esses envelopes não enviam emails reais e não são cobrados, tornando-os perfeitos para testes. Saiba mais sobre envelopes de teste.
- A ação "Aguardar envelope" acaba após 30 dias. Se você espera que os destinatários devam mais tempo, use um novo fluxo de trabalho começando com o gatilho "Quando uma entrega é gerada".
Erros e soluções comuns
- Verifique se a ação Obter uma entrega é executada após a ação Aguardar envelope . As entregas só estarão disponíveis depois que todos os destinatários tiverem concluído sua parte.
- Se você alternar de uma chave de API de teste para uma chave de API dinâmica, 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.
Criando uma conexão
O conector dá suporte aos seguintes tipos de autenticação:
| Default | 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.
Essa não é uma conexão compartilhável. Se o aplicativo de energia 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 |
Limitações
| Nome | Chamadas | Período de renovação |
|---|---|---|
| Chamadas à 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
Parâmetros
| Nome | Chave | Obrigató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. |
|
Value
|
value | True | string |
O valor do campo no modelo. |
Adicionar um destinatário — Signatário
Adiciona um destinatário a um envelope. https://signatureapi.com/docs/integrations/power-automate/actions/add-recipient
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Envelope ID
|
envelopeId | True | string |
A ID do envelope. |
|
Nome do destinatário
|
name | True | string |
O nome do destinatário. |
|
Email do destinatário
|
True | string |
O endereço de email 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 destinatário
|
ceremony_creation | string |
Como as cerimônias de um destinatário são criadas. |
|
|
Tipo de entrega do destinatário
|
delivery_type | string |
Como o entregador é enviado ao destinatário. |
|
|
Propriedades extras
|
extra | string |
Propriedades extras para extensibilidade |
Retornos
- Corpo
- AddRecipientSignerOutput
Adicionar um documento — DOCX
Adiciona um documento DOCX a um envelope. https://signatureapi.com/docs/integrations/power-automate/actions/add-document-docx
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Envelope ID
|
envelopeId | True | string |
A ID do envelope. |
|
Título do documento
|
title | string |
O título deste documento. Isso pode ser mostrado aos destinatários. |
|
|
Conteúdo do arquivo
|
file_content | True | byte |
O conteúdo do arquivo de documento. |
|
Propriedades extras
|
extra | string |
Propriedades extras para extensibilidade |
Retornos
- Corpo
- AddDocumentOutput
Adicionar um documento — PDF
Adiciona um documento PDF a um envelope. https://signatureapi.com/docs/integrations/power-automate/actions/add-document
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Envelope ID
|
envelopeId | True | string |
A ID do envelope. |
|
Título do documento
|
title | string |
O título deste documento. Isso pode ser mostrado aos destinatários. |
|
|
Conteúdo do arquivo
|
file_content | True | byte |
O conteúdo do arquivo de documento. |
|
Propriedades extras
|
extra | string |
Propriedades extras para extensibilidade |
Retornos
- Corpo
- AddDocumentOutput
Adicionar um local — Assinatura
Adiciona um local de assinatura a um documento. https://signatureapi.com/docs/integrations/power-automate/actions/add-signature-place
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do documento
|
documentId | True | string |
A ID do documento. |
|
Tecla Place
|
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 Local
|
height | number |
Defina uma altura personalizada, a largura é ajustada proporcionalmente. |
|
|
Número da Página
|
page | number |
O número da página a ser posicionado neste local. |
|
|
Distância da parte superior
|
top | number |
A distância (em pontos) da parte superior da página até a parte inferior do local. |
|
|
Distância da esquerda
|
left | number |
A distância (em pontos) da esquerda da página até o local. |
|
|
Propriedades extras
|
extra | string |
Propriedades extras para extensibilidade |
Adicionar um local — Data de conclusão do destinatário
Adiciona um local de data concluído pelo destinatário a um documento. https://signatureapi.com/docs/integrations/power-automate/actions/add-recipient-completed-date-place
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do documento
|
documentId | True | string |
A ID do documento. |
|
Tecla Place
|
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 valores permitidos. |
|
|
Número da Página
|
page | number |
O número da página a ser posicionado neste local. |
|
|
Distância da parte superior
|
top | number |
A distância (em pontos) da parte superior da página até a parte inferior do local. |
|
|
Distância da esquerda
|
left | number |
A distância (em pontos) da esquerda da página até o local. |
|
|
Propriedades extras
|
extra | string |
Propriedades extras para extensibilidade |
Adicionar um local — Data de conclusão do envelope
Adiciona um local de data concluído do envelope a um documento. https://signatureapi.com/docs/integrations/power-automate/actions/add-envelope-completed-date-place
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do documento
|
documentId | True | string |
A ID do documento. |
|
Tecla Place
|
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 valores permitidos. |
|
|
Número da Página
|
page | number |
O número da página a ser posicionado neste local. |
|
|
Distância da parte superior
|
top | number |
A distância (em pontos) da parte superior da página até a parte inferior do local. |
|
|
Distância da esquerda
|
left | number |
A distância (em pontos) da esquerda da página até o local. |
|
|
Propriedades extras
|
extra | string |
Propriedades extras para extensibilidade |
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
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do documento
|
documentId | True | string |
A ID do documento. |
|
Tecla Place
|
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 é incluída nas capturas de envelope. |
|
|
Hint
|
hint | string |
Uma mensagem de dica de ferramenta mostrada no campo de entrada do destinatário. |
|
|
Rápido
|
prompt | string |
Uma mensagem de espaço reservado mostrada dentro do campo de texto de entrada durante a cerimônia de assinatura. |
|
|
Requirement
|
requirement | string |
Especifica se o destinatário deve preencher esse 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 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 a ser posicionado neste local. |
|
|
Distância da parte superior
|
top | number |
A distância (em pontos) da parte superior da página até a parte inferior do local. |
|
|
Distância da esquerda
|
left | number |
A distância (em pontos) da esquerda da página até o local. |
|
|
Propriedades extras
|
extra | string |
Propriedades extras para extensibilidade |
Adicionar um local — Iniciais
Adiciona um local de iniciais a um documento. https://signatureapi.com/docs/integrations/power-automate/actions/add-initials-place
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do documento
|
documentId | True | string |
A ID do documento. |
|
Tecla Place
|
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 Local
|
height | number |
Defina uma altura personalizada, a largura é ajustada proporcionalmente. |
|
|
Número da Página
|
page | number |
O número da página a ser posicionado neste local. |
|
|
Distância da parte superior
|
top | number |
A distância (em pontos) da parte superior da página até a parte inferior do local. |
|
|
Distância da esquerda
|
left | number |
A distância (em pontos) da esquerda da página até o local. |
|
|
Propriedades extras
|
extra | string |
Propriedades extras para extensibilidade |
Adicionar um local — Texto
Adiciona um local de texto a um documento. https://signatureapi.com/docs/integrations/power-automate/actions/add-text-place
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do documento
|
documentId | True | string |
A ID do documento. |
|
Tecla Place
|
key | True | string |
Uma chave que identifica esse lugar dentro do documento. |
|
Value
|
value | True | string |
O valor deste local de texto. |
|
Tamanho da fonte
|
font_size | number |
O tamanho da fonte em pontos. |
|
|
Cor da Fonte
|
font_color | string |
A cor da fonte na notação hexadecimal. |
|
|
Número da Página
|
page | number |
O número da página a ser posicionado neste local. |
|
|
Distância da parte superior
|
top | number |
A distância (em pontos) da parte superior da página até a parte inferior do local. |
|
|
Distância da esquerda
|
left | number |
A distância (em pontos) da esquerda da página até o local. |
|
|
Propriedades extras
|
extra | string |
Propriedades extras para extensibilidade |
Adicionar um modelo — DOCX
Adiciona um modelo DOCX a um envelope. https://signatureapi.com/docs/integrations/power-automate/actions/add-template
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Envelope ID
|
envelopeId | True | string |
A ID do envelope. |
|
Título do documento
|
title | string |
O título deste documento. Isso pode ser mostrado aos destinatários. |
|
|
Conteúdo do arquivo
|
file_content | True | byte |
O conteúdo do arquivo de documento. |
|
Dados do modelo
|
data | array of string |
Campo: par de valor que contém dados a serem preenchidos no modelo. |
|
|
Propriedades extras
|
extra | string |
Propriedades extras para extensibilidade |
Retornos
- Corpo
- AddDocumentOutput
Aguarde o envelope
Aguarda que um envelope atinja um estado concluído ou outro status final. https://signatureapi.com/docs/integrations/power-automate/actions/wait-envelope
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Envelope ID
|
envelopeId | True | string |
A ID do envelope. |
Retornos
- Corpo
- 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
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Título do envelope
|
title | True | string |
O título deste envelope. Isso pode ser mostrado aos destinatários. |
|
Rótulo de envelope
|
label | string |
Rótulo personalizado fornecido ao envelope para facilitar a identificação. Os rótulos são para uso interno e não são mostrados aos destinatários. |
|
|
Mensagem de envelope
|
message | string |
Uma mensagem que será enviada aos destinatários. |
|
|
Modo envelope
|
mode | string |
Os envelopes do modo de teste não são associados e não são cobrados. |
|
|
Roteamento de envelope
|
routing | string |
A ordem na qual os destinatários assinam o envelope. Pode ser paralelo, em que todos os destinatários podem assinar simultaneamente ou sequencialmente, em que 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 nas entregas. 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 regulatório ou de conformidade |
|
|
Nome
|
name | string |
O nome do remetente. |
|
|
Email
|
string |
O endereço de email do remetente. |
||
|
Tópicos do envelope
|
topics | array of string |
Use para classificar envelopes e filtrar notificações de webhook. |
|
|
Propriedades extras
|
extra | string |
Propriedades extras para extensibilidade |
Retornos
- Corpo
- CreateEnvelopeOutput
Criar uma cerimônia — Autenticação de link de email
Cria uma cerimônia em que o destinatário é autenticado por meio de um link enviado para seu email. https://signatureapi.com/docs/integrations/power-automate/actions/create-ceremony-email-link
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do destinatário
|
recipientId | True | string |
A ID do destinatário. |
|
URL de redirecionamento
|
redirect_url | string |
Uma URL para a qual redirecionar o destinatário após a conclusão da cerimônia. Saiba mais em: https://signatureapi.com/docs/resources/ceremonies/redirect-url |
|
|
Propriedades extras
|
extra | string |
Propriedades extras para extensibilidade |
Retornos
- response
- object
Criar uma cerimônia — Autenticação personalizada
Cria uma cerimônia em que o destinatário é autenticado externamente no SignatureAPI. Use isso para obter uma URL de cerimônia para compartilhar com os destinatários. Antes de usar a leitura de autenticação personalizada https://signatureapi.com/docs/integrations/power-automate/actions/create-ceremony-custom
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do destinatário
|
recipientId | True | string |
A 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 valor que contém metadados de autenticação. Esses detalhes serão incluídos nos logs de auditoria do envelope. |
|
URL de redirecionamento
|
redirect_url | string |
Uma URL para a qual redirecionar o destinatário após a conclusão da cerimônia. Saiba mais em: https://signatureapi.com/docs/resources/ceremonies/redirect-url |
|
|
Propriedades extras
|
extra | string |
Propriedades extras para extensibilidade |
Retornos
Excluir um envelope
Exclui um envelope e todas as informações associadas. https://signatureapi.com/docs/integrations/power-automate/actions/delete-envelope
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Envelope ID
|
envelopeId | True | string |
A ID do envelope. |
Iniciar um envelope
Inicia o processo de assinatura de um envelope. https://signatureapi.com/docs/integrations/power-automate/actions/start-envelope
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Envelope ID
|
envelopeId | True | string |
A ID do envelope. |
Retornos
- Corpo
- StartEnvelopeOutput
Obter um destinatário
Recupera os detalhes do destinatário por sua ID. https://signatureapi.com/docs/integrations/power-automate/actions/get-recipient
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do destinatário
|
recipientId | True | string |
A ID do destinatário. |
Retornos
- Corpo
- Recipient
Obter um envelope
Recupera os detalhes do envelope por sua ID. https://signatureapi.com/docs/integrations/power-automate/actions/get-envelope
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Envelope ID
|
envelopeId | True | string |
A ID do envelope. |
Retornos
- Corpo
- Envelope
Obter 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
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Envelope ID
|
envelopeId | True | string |
A ID do envelope. |
|
Chave de captura
|
captureKey | True | string |
A chave do valor capturado. |
Retornos
- Corpo
- Capture
Obter uma entrega
Recupera uma entrega 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
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID de entrega
|
deliverableId | True | string |
O ID do material a entregar. |
Retornos
- Corpo
- Deliverable
Gatilhos
| Quando um destinatário falha |
Esse evento ocorre quando há uma falha relacionada a um destinatário, resultando em um status de destinatário com falha. |
| Quando um destinatário é concluído |
Esse evento ocorre quando um destinatário conclui sua parte do processo de assinatura. |
| 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 concluir um envelope. |
| Quando um destinatário é rejeitado |
Esse evento ocorre quando um destinatário rejeita o envelope. |
| Quando um destinatário é ressentido |
Esse evento ocorre quando uma solicitação é ressentida com um destinatário. |
| Quando um destinatário é saltados |
Esse evento ocorre quando um email não é entregue, temporariamente (soft-bounce) ou permanentemente (hard-bounce). |
| 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 com falha. |
| Quando um envelope é cancelado |
Esse evento ocorre quando o processo de assinatura foi interrompido intencionalmente antes da conclusão, resultando em um status de envelope cancelado. |
| Quando um envelope é concluído |
Esse evento ocorre quando um status de envelope faz a transição de in_progress para concluído, indicando que foi concluído por todos os destinatários. |
| Quando um envelope é criado |
Esse evento ocorre sempre que um Envelope é criado. |
| Quando um envelope é iniciado |
Esse evento ocorre quando um status de envelope faz a transição do processamento para o in_progress, indicando que ele está pronto para ser enviado aos destinatários. |
| Quando uma entrega falha |
Esse evento ocorre quando a geração de uma entrega falha, resultando em um status de entrega com falha. |
| Quando uma entrega é gerada |
Esse evento ocorre quando uma entrega, como um log de auditoria, é gerada com êxito. |
Quando um destinatário falha
Esse evento ocorre quando há uma falha relacionada a um destinatário, resultando em um status de destinatário com falha.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Tópicos
|
topics | array of string |
Use para classificar envelopes e filtrar notificações de webhook. |
Retornos
Quando um destinatário é concluído
Esse evento ocorre quando um destinatário conclui sua parte do processo de assinatura.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Tópicos
|
topics | array of string |
Use para classificar envelopes e filtrar notificações de webhook. |
Retornos
Quando um destinatário é enviado
Esse evento ocorre quando uma solicitação é enviada a um destinatário.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Tópicos
|
topics | array of string |
Use para classificar envelopes e filtrar notificações de webhook. |
Retornos
Quando um destinatário é liberado
Esse evento ocorre quando um destinatário está pronto para receber uma solicitação para concluir um envelope.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Tópicos
|
topics | array of string |
Use para classificar envelopes e filtrar notificações de webhook. |
Retornos
Quando um destinatário é rejeitado
Esse evento ocorre quando um destinatário rejeita o envelope.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Tópicos
|
topics | array of string |
Use para classificar envelopes e filtrar notificações de webhook. |
Retornos
Quando um destinatário é ressentido
Esse evento ocorre quando uma solicitação é ressentida com um destinatário.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Tópicos
|
topics | array of string |
Use para classificar envelopes e filtrar notificações de webhook. |
Retornos
Quando um destinatário é saltados
Esse evento ocorre quando um email não é entregue, temporariamente (soft-bounce) ou permanentemente (hard-bounce).
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Tópicos
|
topics | array of string |
Use para classificar envelopes e filtrar notificações de webhook. |
Retornos
Quando um destinatário é substituído
Esse evento ocorre quando um destinatário é substituído por um novo.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Tópicos
|
topics | array of string |
Use para classificar envelopes e filtrar notificações de webhook. |
Retornos
Quando um envelope falha
Esse evento ocorre quando um envelope falha, resultando em um status de envelope com falha.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Tópicos
|
topics | array of string |
Use para classificar envelopes e filtrar notificações de webhook. |
Retornos
Quando um envelope é cancelado
Esse evento ocorre quando o processo de assinatura foi interrompido intencionalmente antes da conclusão, resultando em um status de envelope cancelado.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Tópicos
|
topics | array of string |
Use para classificar envelopes e filtrar notificações de webhook. |
Retornos
Quando um envelope é concluído
Esse evento ocorre quando um status de envelope faz a transição de in_progress para concluído, indicando que foi concluído por todos os destinatários.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Tópicos
|
topics | array of string |
Use para classificar envelopes e filtrar notificações de webhook. |
Retornos
Quando um envelope é criado
Esse evento ocorre sempre que um Envelope é criado.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Tópicos
|
topics | array of string |
Use para classificar envelopes e filtrar notificações de webhook. |
Retornos
Quando um envelope é iniciado
Esse evento ocorre quando um status de envelope faz a transição do processamento para o in_progress, indicando que ele está pronto para ser enviado aos destinatários.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Tópicos
|
topics | array of string |
Use para classificar envelopes e filtrar notificações de webhook. |
Retornos
Quando uma entrega falha
Esse evento ocorre quando a geração de uma entrega falha, resultando em um status de entrega com falha.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Tópicos
|
topics | array of string |
Use para classificar envelopes e filtrar notificações de webhook. |
Retornos
Quando uma entrega é gerada
Esse evento ocorre quando uma entrega, como um log de auditoria, é gerada com êxito.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Tópicos
|
topics | array of string |
Use para classificar envelopes e filtrar notificações de webhook. |
Retornos
Definições
Envelope
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Envelope ID
|
id | EnvelopeId |
A ID do envelope. |
|
Título do envelope
|
title | EnvelopeTitle |
O título deste envelope. Isso pode ser mostrado aos destinatários. |
|
Rótulo de envelope
|
label | EnvelopeLabel |
Rótulo personalizado fornecido ao envelope para facilitar a identificação. Os rótulos são para uso interno e não são mostrados aos destinatários. |
|
Mensagem de envelope
|
message | EnvelopeMessage |
Uma mensagem que será enviada aos destinatários. |
|
remetente
|
sender | EnvelopeSender | |
|
Envelope Status
|
status | EnvelopeStatus |
O status do envelope. |
|
Entrega
|
deliverable | EnvelopeDeliverable | |
|
Envelope concluído em
|
completed_at | EnvelopeCompletedAt |
Hora em que todos os destinatários concluíram o envelope. |
|
Modo envelope
|
mode | EnvelopeMode |
Os envelopes do modo de teste não são associados e não são cobrados. |
|
Roteamento de envelope
|
routing | EnvelopeRouting |
A ordem na qual os destinatários assinam o envelope. Pode ser paralelo, em que todos os destinatários podem assinar simultaneamente ou sequencialmente, em que 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 regulatório ou de conformidade |
|
Tópicos do envelope
|
topics | EnvelopeTopics |
Use para classificar envelopes e filtrar notificações de webhook. |
Recipient
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
ID do destinatário
|
id | RecipientId |
A ID do destinatário. |
|
Envelope ID
|
envelope_id | EnvelopeId |
A 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. |
|
Email do destinatário
|
RecipientEmail |
O endereço de email do destinatário. |
|
|
Status do destinatário
|
status | RecipientStatus |
O status do destinatário. |
|
Criação da cerimônia de destinatário
|
ceremony_creation | RecipientCeremonyCreation |
Como as cerimônias de um destinatário são criadas. |
|
Tipo de entrega do destinatário
|
delivery_type | RecipientDeliveryType |
Como o entregador é enviado ao destinatário. |
|
Destinatário concluído em
|
completed_at | RecipientCompletedAt |
Hora em que o destinatário concluiu o envelope. |
Material a Entregar
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
ID de entrega
|
id | DeliverableId |
O ID do material a entregar. |
|
Tipo de entrega
|
type | DeliverableType |
O tipo de entrega. |
|
Status de entrega
|
status | DeliverableStatus |
O status da entrega. |
|
Conteúdo do arquivo
|
file_content | DeliverableFileContent |
O conteúdo do arquivo do entregue. Use-o para salvar uma cópia assinada do envelope. |
Captura
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Valor de captura
|
value | CaptureValue |
O valor da captura de entrada do destinatário |
CreateEnvelopeOutput
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Envelope ID
|
id | EnvelopeId |
A ID do envelope. |
|
Título do envelope
|
title | EnvelopeTitle |
O título deste envelope. Isso pode ser mostrado aos destinatários. |
|
Rótulo de envelope
|
label | EnvelopeLabel |
Rótulo personalizado fornecido ao envelope para facilitar a identificação. Os rótulos são para uso interno e não são mostrados aos destinatários. |
|
Mensagem de envelope
|
message | EnvelopeMessage |
Uma mensagem que será enviada aos destinatários. |
|
remetente
|
sender | EnvelopeSender | |
|
Modo envelope
|
mode | EnvelopeMode |
Os envelopes do modo de teste não são associados e não são cobrados. |
|
Roteamento de envelope
|
routing | EnvelopeRouting |
A ordem na qual os destinatários assinam o envelope. Pode ser paralelo, em que todos os destinatários podem assinar simultaneamente ou sequencialmente, em que 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 regulatório ou de conformidade |
|
Tópicos do envelope
|
topics | EnvelopeTopics |
Use para classificar envelopes e filtrar notificações de webhook. |
StartEnvelopeOutput
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Envelope Status
|
status | EnvelopeStatus |
O status do envelope. |
AddDocumentOutput
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
ID do documento
|
id | DocumentId |
A ID do documento |
AddRecipientSignerOutput
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
ID do destinatário
|
id | RecipientId |
A ID do destinatário. |
|
Nome do destinatário
|
name | RecipientName |
O nome do destinatário. |
|
Email do destinatário
|
RecipientEmail |
O endereço de email 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 destinatário
|
ceremony_creation | RecipientCeremonyCreation |
Como as cerimônias de um destinatário são criadas. |
|
Tipo de entrega do destinatário
|
delivery_type | RecipientDeliveryType |
Como o entregador é enviado ao destinatário. |
CreateCeremonyCustomOutput
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
URL da cerimônia
|
url | CeremonyUrl |
A URL que o destinatário deve visitar para iniciar a cerimônia |
EnvelopeId
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
Rótulo personalizado fornecido ao envelope para facilitar a identificação. Os rótulos são para uso interno e não são mostrados aos destinatários.
Rótulo personalizado fornecido ao envelope para facilitar a identificação. Os rótulos são para uso interno e não são mostrados aos destinatários.
- Rótulo de 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 na qual os destinatários assinam o envelope. Pode ser paralelo, em que todos os destinatários podem assinar simultaneamente ou sequencialmente, em que os destinatários assinam um após o outro.
A ordem na qual os destinatários assinam o envelope. Pode ser paralelo, em que todos os destinatários podem assinar simultaneamente ou sequencialmente, em que os destinatários assinam um após o outro.
- Roteamento de envelope
- 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
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Nome do remetente
|
name | string |
O nome do remetente. |
|
Email do remetente
|
string |
O endereço de email do remetente. |
EnvelopeStatus
EnvelopeMode
Os envelopes do modo de teste não são associados e não são cobrados.
Os envelopes do modo de teste não são associados e não são cobrados.
- Modo envelope
- string
EnvelopeTopics
Use para classificar envelopes e filtrar notificações de webhook.
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Itens
|
string |
EnvelopeAttestation
Atestado regulatório ou de conformidade
Atestado regulatório ou de conformidade
- Atestado de envelope
- string
EnvelopeDeliverable
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
ID de entrega
|
id | string |
O ID do material a entregar. Use isso para baixar uma cópia assinada do envelope. |
EnvelopeCompletedAt
Hora em que todos os destinatários concluíram o envelope.
Hora em que todos os destinatários concluíram o envelope.
- Envelope concluído em
- date-time
DocumentId
RecipientId
RecipientType
RecipientName
RecipientEmail
O endereço de email do destinatário.
O endereço de email do destinatário.
- Email do destinatário
- string
RecipientKey
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
RecipientStatus
RecipientCeremonyCreation
Como as cerimônias de um destinatário são criadas.
Como as cerimônias de um destinatário são criadas.
- Criação da cerimônia de destinatário
- string
RecipientDeliveryType
Como o entregador é enviado ao destinatário.
Como o entregador é enviado ao destinatário.
- Tipo de entrega do destinatário
- string
RecipientCompletedAt
Hora em que o destinatário concluiu o envelope.
Hora em que o destinatário concluiu o envelope.
- Destinatário concluído em
- date-time
DeliverableId
DeliverableType
DeliverableStatus
DeliverableFileContent
O conteúdo do arquivo do entregue. Use-o para salvar uma cópia assinada do envelope.
O conteúdo do arquivo do entregue. Use-o para salvar uma cópia assinada do envelope.
- Conteúdo do arquivo
- byte
CeremonyUrl
A URL que o destinatário deve visitar para iniciar a cerimônia
A URL que o destinatário deve visitar para iniciar a cerimônia
- URL da cerimônia
- string
CaptureValue
O valor da captura de entrada do destinatário
O valor da captura de entrada do destinatário
- Valor de captura
- string
NotificationForEnvelopeCreated
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
ID do evento
|
id | EventId |
A ID do evento. |
|
Timestamp do evento
|
timestamp | EventTimestamp |
A data e a 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 ao qual este evento se refere. |
NotificationForEnvelopeStarted
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
ID do evento
|
id | EventId |
A ID do evento. |
|
Timestamp do evento
|
timestamp | EventTimestamp |
A data e a 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 ao qual este evento se refere. |
NotificationForEnvelopeCompleted
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
ID do evento
|
id | EventId |
A ID do evento. |
|
Timestamp do evento
|
timestamp | EventTimestamp |
A data e a 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 ao qual este evento se refere. |
NotificationForEnvelopeFailed
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
ID do evento
|
id | EventId |
A ID do evento. |
|
Timestamp do evento
|
timestamp | EventTimestamp |
A data e a 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 ao qual este evento se refere. |
|
Detalhes
|
data.detail | string |
Informações sobre a falha. |
NotificationForEnvelopeCanceled
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
ID do evento
|
id | EventId |
A ID do evento. |
|
Timestamp do evento
|
timestamp | EventTimestamp |
A data e a 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 ao qual este evento se refere. |
NotificationForRecipientReleased
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
ID do evento
|
id | EventId |
A ID do evento. |
|
Timestamp do evento
|
timestamp | EventTimestamp |
A data e a 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 ao qual 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 ao qual esse evento se refere. |
|
Chave do destinatário
|
data.recipient_key | EventRecipientKey |
A chave do destinatário a que este evento se refere. |
NotificationForRecipientSent
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
ID do evento
|
id | EventId |
A ID do evento. |
|
Timestamp do evento
|
timestamp | EventTimestamp |
A data e a 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 ao qual 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 ao qual esse evento se refere. |
|
Chave do destinatário
|
data.recipient_key | EventRecipientKey |
A chave do destinatário a que este evento se refere. |
NotificationForRecipientCompleted
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
ID do evento
|
id | EventId |
A ID do evento. |
|
Timestamp do evento
|
timestamp | EventTimestamp |
A data e a 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 ao qual 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 ao qual esse evento se refere. |
|
Chave do destinatário
|
data.recipient_key | EventRecipientKey |
A chave do destinatário a que este evento se refere. |
NotificationForRecipientRejected
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
ID do evento
|
id | EventId |
A ID do evento. |
|
Timestamp do evento
|
timestamp | EventTimestamp |
A data e a 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 ao qual 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 ao qual esse 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
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
ID do evento
|
id | EventId |
A ID do evento. |
|
Timestamp do evento
|
timestamp | EventTimestamp |
A data e a 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 ao qual 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 ao qual esse evento se refere. |
|
Chave do destinatário
|
data.recipient_key | EventRecipientKey |
A chave do destinatário a que este evento se refere. |
|
Detalhes
|
data.detail | string |
Informações sobre o salto. |
NotificationForRecipientFailed
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
ID do evento
|
id | EventId |
A ID do evento. |
|
Timestamp do evento
|
timestamp | EventTimestamp |
A data e a 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 ao qual 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 ao qual esse evento se refere. |
|
Chave do destinatário
|
data.recipient_key | EventRecipientKey |
A chave do destinatário a que este evento se refere. |
|
Detalhes
|
data.detail | string |
Informações sobre a falha. |
NotificationForRecipientReplaced
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
ID do evento
|
id | EventId |
A ID do evento. |
|
Timestamp do evento
|
timestamp | EventTimestamp |
A data e a 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 ao qual 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 ao qual esse evento se refere. |
|
Chave do destinatário
|
data.recipient_key | EventRecipientKey |
A chave do destinatário a que este evento se refere. |
|
Nova ID do Destinatário
|
data.new_recipient_id | string |
A ID do novo destinatário. |
NotificationForRecipientResent
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
ID do evento
|
id | EventId |
A ID do evento. |
|
Timestamp do evento
|
timestamp | EventTimestamp |
A data e a 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 ao qual 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 ao qual esse evento se refere. |
|
Chave do destinatário
|
data.recipient_key | EventRecipientKey |
A chave do destinatário a que este evento se refere. |
NotificationForDeliverableGenerated
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
ID do evento
|
id | EventId |
A ID do evento. |
|
Timestamp do evento
|
timestamp | EventTimestamp |
A data e a 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 ao qual este evento se refere. |
|
ID de entrega
|
data.object_id | EventDeliverableId |
A ID do evento de entrega a que este evento se refere. |
NotificationForDeliverableFailed
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
ID do evento
|
id | EventId |
A ID do evento. |
|
Timestamp do evento
|
timestamp | EventTimestamp |
A data e a 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 ao qual este evento se refere. |
|
ID de entrega
|
data.object_id | EventDeliverableId |
A ID do evento de entrega a que este evento se refere. |
|
Detalhes
|
data.detail | string |
Informações sobre a falha. |
EventId
EventTimestamp
A data e a hora do evento, no formato ISO 8601.
A data e a hora do evento, no formato ISO 8601.
- Timestamp do evento
- date-time
Tipo de Evento
EventEnvelopeId
A ID do envelope ao qual este evento se refere.
A ID do envelope ao qual 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 ao qual esse evento se refere.
O tipo de destinatário ao qual esse 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 evento de entrega a que este evento se refere.
A ID do evento de entrega a que este evento se refere.
- ID de entrega
- string
objeto
Esse é o tipo 'object'.