Como configurar webhooks para ser notificado de novas submissões de formulários PDF

Benjamin André-Micolon

Uma forma poderosa de enviar as submissões para a sua aplicação ou ligar o SimplePDF a outros serviços como o Zapier ou o Activepieces é utilizar webhooks.

Webhooks?

Os webhooks permitem ligar aplicações entre si, enviando dados em tempo real de uma aplicação para outra(s) sempre que um determinado evento ocorre.

No SimplePDF, sempre que um PDF é submetido através do portal da sua empresa, seja usando ligações de formulário ou incorporação no seu website, é enviado um evento contendo o nome do documento e o URL da submissão, entre outras informações.

A partir daí, o céu é o limite e pode deixar a imaginação correr livremente.

Pode, por exemplo, guardar essa informação numa folha do Google Sheets ou integrá-la com o Zapier ou o Activepieces e desbloquear ainda mais possibilidades!

Configurar webhooks no SimplePDF

A configuração de webhooks está disponível com o plano BASIC

Inicie sessão na sua conta
Navegue até à vista de definições da conta

Configurar webhooks na vista da conta

Clique em Update configuration
Introduza o URL do webhook do serviço ou aplicação para o qual pretende enviar eventos

Configurar webhooks: detalhes da configuração

Opcional: especifique os cabeçalhos a enviar como parte do webhook

E pronto! Um evento será enviado sempre que houver uma nova submissão

Eventos de webhook

Abaixo encontra os eventos que são enviados pelo SimplePDF para o webhook que configurou.

Nova submissão

Payload

type: "submission.created",
data: {
  document: {
    id: "b7615a68-9e1f-4eac-bd20-5e80632a4d9e",
    name: "your_document.pdf",
  },
  submission: {
    id: "80146d5b-a068-490f-8eb9-fe393ba11396",
    submitted_at: "2023-06-04T11:54:58.995Z",
    url: "short_lived_15min_url",
  },
  context: {
    environment: "production",
    customer_id: "123"
  }
}

Sobre o contexto

Quando integra o SimplePDF no seu website, pode querer associar informação adicional às submissões.

Por exemplo, pode querer:

Saber se a submissão foi iniciada a partir de um ambiente de development vs um de production.
Enviar detalhes adicionais sobre quem submeteu o formulário (como um utilizador autenticado) para facilitar o processamento da submissão.

Saiba como especificar um context na documentação do SimplePDF embed

Playground

No SimplePDF gostamos de exemplos, então que tal um exemplo real de como os webhooks funcionam?

Modifique o contexto abaixo (clique para editar o conteúdo)

{"environment":"production","customer_id":"123"}

Submeta este formulário
O webhook enviado pelo SimplePDF aparecerá aqui