Formulários cognito

O Cognito Forms é um construtor de formulários online para coletar e gerenciar dados de envio. Esse conector permite que fluxos automatizados sejam disparados quando as entradas são criadas, atualizadas ou excluídas e fornece ações para criar, atualizar e recuperar entradas. Integre o Cognito Forms a outros serviços para rotear dados, processar arquivos carregados e automatizar fluxos de trabalho de negócios.

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

Service Class Regions
Copilot Studio Standard Todas as regiões 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:
     – Azure Governamental regiões
     - Azure regiões da China
     - Departamento de Defesa dos EUA (DoD)
Power Apps Standard Todas as regiões 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 Standard Todas as regiões 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 Suporte do Cognito Forms
URL https://www.cognitoforms.com/support
Email support@cognitoforms.com
Metadados do conector
Publisher Cognito Forms, LLC
Site https://www.cognitoforms.com
Política de Privacidade https://www.cognitoforms.com/legal/privacy
Categorias Produtividade; Colaboração

Formulários cognito

O Cognito Forms permite que você crie facilmente formulários online avançados, como pesquisas, formulários de pedidos, formulários de registro e muito mais. De graça. Consulte nossa documentação support ou contact us para obter ajuda com nosso conector de Power Automate público.

Publisher: Cognito Forms

Pré-requisitos

Uma assinatura paga é necessária.

Operações com suporte

Triggers

Os gatilhos serão enviados logo após a ocorrência do evento assinado.

NewEntry

Isso será disparado quando uma nova entrada for criada para o formulário especificado. A saída serão os dados de entrada, incluindo dados de arquivo e links temporários para arquivos, assinaturas e documentos de entrada.

Parâmetros:
  • form: o nome do formulário para o qual novos eventos de entrada serão assinados.

UpdateEntry

Isso será disparado quando uma entrada for atualizada para o formulário especificado. A saída serão os dados de entrada, incluindo dados de arquivo e links temporários para arquivos, assinaturas e documentos de entrada.

Parâmetros:
  • form: o nome do formulário para o qual os eventos de entrada atualizados serão assinados.

EntryDeleted

Isso será disparado quando uma entrada for excluída para o formulário especificado. A saída serão os dados de entrada, excluindo links.

Parâmetros:
  • form: o nome do formulário para o qual os eventos excluídos de entrada serão assinados.

Ações

CreateEntry

Essa ação criará uma entrada para o formulário especificado. A ação incluirá propriedades configuráveis para cada campo de entrada, excluindo alguns tipos de campo. A saída serão os dados de entrada.

Parâmetros:
  • form: o nome do formulário interno ou a ID

EditEntry

Essa ação atualizará uma entrada existente para o formulário especificado. A ação incluirá propriedades configuráveis para cada campo de entrada, excluindo alguns tipos de campo. Essa ação falhará se a entrada incluir um pedido pago ou se a entryId não existir. A saída será os dados de entrada atualizados.

Parâmetros:
  • form: o nome do formulário interno ou a ID
  • entryId: o número de entrada ou a ID de entrada para a entrada a ser atualizada

SetFormAvailability

Essa ação definirá as configurações de disponibilidade de limite do formulário. O start e end os parâmetros devem estar em branco para disponibilizar o formulário o tempo todo. A saída será as configurações de disponibilidade atualizadas.

Parâmetros:
  • form: o nome do formulário interno ou a ID
  • start: o datetime no qual o formulário deve ficar disponível.
  • end: o datetime no qual o formulário não deve mais estar disponível.
  • message: a mensagem que deve ser mostrada aos usuários que tentam acessar o formulário quando estiver fora do período de disponibilidade.

GetFile

Essa ação recuperará um arquivo do armazenamento. A saída será um objeto que contém os dados do arquivo, os metadados e um link temporário para o arquivo.

Parâmetros:
  • id: a ID do arquivo a ser recuperado.

GetDocument

Essa ação gerará e recuperará um documento de entrada usando o formulário, a entrada e o modelo especificados. A saída será um objeto que contém os dados do arquivo do documento, os metadados e um link temporário para o documento.

Parâmetros:
  • form: o nome do formulário interno ou a ID
  • entry: A ID de entrada ou o número de entrada da entrada para a qual o documento deve ser gerado
  • templateNumber: o número do modelo que deve ser usado para gerar o documento de entrada

GetEntry

Essa ação obterá uma entrada existente para o formulário especificado. Essa ação falhará se a entrada não existir. A saída serão os dados de entrada.

Parâmetros:
  • form: o nome do formulário interno ou a ID
  • entryId: o número de entrada ou a ID de entrada para a entrada a ser recuperada

DeleteEntry

Essa ação excluirá uma entrada existente para o formulário especificado. Essa ação falhará se a entrada não existir. Não haverá saída.

Parâmetros:
  • form: o nome do formulário interno ou a ID
  • entryId: o número de entrada ou a ID de entrada para a entrada a ser excluída

ImportEntries

Essa ação criará, atualizará ou excluirá entradas usando o conteúdo do arquivo fornecido (.xlsx ou .csv). A saída será um objeto que contém a ID de importação e o status.

Parâmetros:
  • form: o nome do formulário interno ou a ID
  • File: o arquivo (.xlsx ou .csv) que contém as entradas a serem importadas
  • ImportMode: o modo de importação (CreateNew, UpdateExisting ou SyncEntries)
  • Email: o endereço de email para receber notificações de importação (opcional)
  • MatchEntriesUsing: um substituto de ID de entrada (opcional)

GetImportStatus

Essa ação obterá o status atual de uma importação e retornará o número de entradas bem-sucedidas e malsucedidas. A saída será um objeto que contém o status de importação, contagens e informações de erro, se aplicável.

Parâmetros:
  • form: o nome do formulário interno ou a ID
  • importId: a ID da importação para verificar o status

UploadFile

Essa ação carregará um arquivo no Cognito Forms.

Parâmetros:
  • fileContent: os dados binários do arquivo
  • fileName: o nome do arquivo

GetEntryViewEntries

Essa ação obterá todas as entradas para um modo de exibição especificado. A saída será os dados de entrada com base na configuração de exibição.

Parâmetros:
  • form: o nome do formulário interno ou a ID
  • viewId: a ID do modo de exibição
  • $count: inclua a contagem total de entradas (opcional)
  • $select: retorna a lista de IDs de entrada em um modo de exibição quando $select=Id é especificado (opcional)

Operações Privadas

Essas operações são habilitadores para os gatilhos e ações públicos.

GetForms

Esta operação retornará uma lista de formulários como objetos que contêm o Id e Name. Quando usado para o form parâmetro para ações e gatilhos, o usuário deve ver o Name, mas o Id deve ser enviado para a API. Os formulários arquivados não estão incluídos na resposta.

GetFormSchema

Essa operação retornará o esquema do formulário especificado. O input parâmetro deve ser verdadeiro para que as ações excluam as propriedades somente leitura e false para que os gatilhos incluam todas as propriedades. O includeLinks parâmetro deve ser verdadeiro para todas as ações e gatilhos, exceto para EntryDeleted.

Parâmetros:
  • form: o nome do formulário interno ou a ID
  • input: um booliano que indica se o esquema retornado deve excluir propriedades que não podem ser definidas. False por padrão.
  • includeLinks: um booliano que indica se as propriedades de link para arquivos, assinaturas e documentos devem ser incluídas no esquema. True por padrão.

CancelarsubscribeWebhook

Essa operação cancelará a assinatura do webhook especificado. O webhook não receberá mais eventos depois que todos os eventos na fila tiverem sido enviados.

Parâmetros:
  • id: a ID do webhook que deve ser desinscrita.
  • module: o módulo do webhook. Isso deve ser definido como "formulários", pois esse conector só dá suporte a esse módulo.

Obtendo credenciais

Um proprietário da organização deve fazer logon no Cognito Forms e autorizar a conexão.

Problemas conhecidos

None

Instruções de implantação

O Cognito Forms requer um conector válido Client id e Client secret um conector. Essas propriedades podem ser encontradas no cofre de chaves e devem ser definidas apenas nas configurações de autenticação do conector personalizado.

  1. Run:

     paconn create --api-def apiDefinition.swagger.json --api-prop apiProperties.json
    
  2. Fazer logon no PowerAutomate

  3. Navegue até o novo conector

  4. Em "Segurança" atualize o Client id e Client secret

  5. Atualizar o conector

Limitações

Nome Chamadas Período de renovação
Chamadas à API por conexão 100 60 segundos

Ações

Carregar Arquivo

Carrega um arquivo a ser usado em entradas de formulário.

Criar entrada

Cria uma nova entrada.

Definir a disponibilidade do formulário

Define a disponibilidade de um formulário.

Entrada de atualização

Atualiza uma entrada.

Excluir entrada

Excluir uma entrada.

Importar Entradas

Cria, atualiza ou exclui entradas usando o conteúdo do arquivo fornecido.

Obter arquivo

Obtém um arquivo por id.

Obter Documento

Obtém um documento

Obter entrada

Obtém uma entrada.

Obter entradas de formulário

Obter todas as entradas para um modo de exibição especificado

Obter status de importação

Obtém o status atual de uma importação e retorna o número de entradas bem-sucedidas e malsucedidas.

Carregar Arquivo

Carrega um arquivo a ser usado em entradas de formulário.

Parâmetros

Nome Chave Obrigatório Tipo Description
File
File True file

O arquivo a ser carregado.

Retornos

Nome Caminho Tipo Description
ID do arquivo
Id string

A ID exclusiva do arquivo.

Nome do Arquivo
Name string

O nome do arquivo

Tipo de conteúdo do arquivo
ContentType string

O tipo de conteúdo do arquivo.

Tamanho do arquivo
Size integer

O tamanho do arquivo em bytes.

Criar entrada

Cria uma nova entrada.

Parâmetros

Nome Chave Obrigatório Tipo Description
Formulário
form True string

O nome do formulário

Entry
entry True dynamic

A entrada a ser criada para o formulário

Retornos

As saídas desta operação são dinâmicas.

Definir a disponibilidade do formulário

Define a disponibilidade de um formulário.

Parâmetros

Nome Chave Obrigatório Tipo Description
Formulário
form True string

O nome do formulário

Início da Disponibilidade
start date-time

Data de início da disponibilidade

Fim da Disponibilidade
end date-time

Data de término da disponibilidade

Mensagem não disponível
message string

Mensagem não disponível

Retornos

Informações de disponibilidade do formulário, como disponibilidade de início/término e mensagem não disponível.

Entrada de atualização

Atualiza uma entrada.

Parâmetros

Nome Chave Obrigatório Tipo Description
Formulário
form True string

O nome do formulário

ID de entrada
entryId True string

A ID de entrada

Entry
entry True dynamic

Os dados de entrada atualizados

Retornos

As saídas desta operação são dinâmicas.

Excluir entrada

Excluir uma entrada.

Parâmetros

Nome Chave Obrigatório Tipo Description
Formulário
form True string

O nome do formulário

ID de entrada
entryId True string

A ID de entrada

Importar Entradas

Cria, atualiza ou exclui entradas usando o conteúdo do arquivo fornecido.

Parâmetros

Nome Chave Obrigatório Tipo Description
Formulário
form True string

O nome do formulário

Importar arquivo
File True file

O arquivo (.xlsx ou .csv) que contém as entradas a serem importadas.

Modo de Importação
ImportMode True string

O modo para a importação

Email de notificação
Email email

O endereço de email para receber notificações de importação

Campo de correspondência
MatchEntriesUsing string

Um substituto de ID de entrada

Retornos

Nome Caminho Tipo Description
ID
Id string

A ID da importação

Status
Status string

O status da importação

Mensagem de Erro
ErrorMessage string

Uma mensagem que descreve por que a importação falhou

Obter arquivo

Obtém um arquivo por id.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do arquivo
id True string

O identificador exclusivo do arquivo

Retornos

Uma referência de arquivo que inclui dados de arquivo e metadados

Corpo
FileDataRef

Obter Documento

Obtém um documento

Parâmetros

Nome Chave Obrigatório Tipo Description
Formulário
form True string

O nome do formulário

ID de entrada
entry True string

A ID de entrada

Número do modelo
templateNumber True integer

O número do modelo

Retornos

Uma referência de arquivo que inclui dados de arquivo e metadados

Corpo
FileDataRef

Obter entrada

Obtém uma entrada.

Parâmetros

Nome Chave Obrigatório Tipo Description
Formulário
form True string

O nome do formulário

ID de entrada
entryId True string

A ID de entrada

Retornos

As saídas desta operação são dinâmicas.

Obter entradas de formulário

Obter todas as entradas para um modo de exibição especificado

Parâmetros

Nome Chave Obrigatório Tipo Description
Formulário
form True string

O nome do formulário

ID da Exibição
viewId True string

A ID da exibição

Incluir Contagem
$count string

Incluir contagem total de entradas

Selecionar IDs
$select string

Retorna a lista de IDs de entrada em um modo de exibição quando $select=Id é especificado

Retornos

response
object

Obter status de importação

Obtém o status atual de uma importação e retorna o número de entradas bem-sucedidas e malsucedidas.

Parâmetros

Nome Chave Obrigatório Tipo Description
Formulário
form True string

O nome do formulário

ID de importação
importId True string

A ID de importação

Retornos

Nome Caminho Tipo Description
ID
Id string

A ID da importação

Status
Status string

O status da importação

Mensagem de Erro
ErrorMessage string

Uma mensagem que descreve por que a importação falhou

SuccessfulEntries
SuccessfulEntries integer

O número de entradas importadas com êxito

UnsuccessfulEntries
UnsuccessfulEntries integer

O número de entradas que falharam na importação

TotalEntries
TotalEntries integer

O número total de entradas na importação

ImportLink
ImportLink string

O link para a página de entradas para baixar o arquivo anotado

Gatilhos

Quando uma entrada é atualizada

Dispara quando alguém atualiza uma entrada.

Quando uma entrada é excluída

Dispara quando alguém exclui uma entrada.

Quando uma nova entrada é criada

Dispara quando alguém cria uma nova entrada.

Quando uma entrada é atualizada

Dispara quando alguém atualiza uma entrada.

Parâmetros

Nome Chave Obrigatório Tipo Description
Formulário
publisher True string

O nome do formulário

Retornos

As saídas desta operação são dinâmicas.

Quando uma entrada é excluída

Dispara quando alguém exclui uma entrada.

Parâmetros

Nome Chave Obrigatório Tipo Description
Formulário
publisher True string

O nome do formulário

Retornos

As saídas desta operação são dinâmicas.

Quando uma nova entrada é criada

Dispara quando alguém cria uma nova entrada.

Parâmetros

Nome Chave Obrigatório Tipo Description
Formulário
publisher True string

O nome do formulário

Retornos

As saídas desta operação são dinâmicas.

Definições

FileDataRef

Uma referência de arquivo que inclui dados de arquivo e metadados

Nome Caminho Tipo Description
ID do arquivo
Id string

A ID exclusiva do arquivo.

Nome do Arquivo
Name string

O nome do arquivo

Tipo de conteúdo do arquivo
ContentType string

O tipo de conteúdo do arquivo.

Tamanho do arquivo
Size integer

O tamanho do arquivo.

URL do Arquivo
File string

A URL do arquivo.

Conteúdo do arquivo
Content byte

O conteúdo do arquivo

FormAvailability

Informações de disponibilidade do formulário, como disponibilidade de início/término e mensagem não disponível.

Nome Caminho Tipo Description
Início da disponibilidade do formulário
availabilityStart date-time

Início da disponibilidade do formulário

Fim da disponibilidade do formulário
availabilityEnd date-time

Fim da disponibilidade do formulário

Mensagem não disponível
notAvailableMessage string

Mensagem não disponível

objeto

Esse é o tipo 'object'.