Como usar webhooks no Pipefy

Webhooks funcionam como um gatilho entre dois aplicativos, alertando outras APIs ou softwares sobre eventos no Pipey.

B
Escrito por Bruna Griebeler
Atualizado há mais de uma semana

Tempo estimado de leitura: 3 minutos

Os Webhooks são uma maneira fácil e eficiente de um software específico alertar outro software.

Ao usar Webhooks, você será notificado automaticamente quando um evento, como um novo card, acontecer em vez de solicitar continuamente ao outro software para essas informações.

O que é um Webhook?

Um webhook é como uma API que pode alertar outra API ou software. Ele funciona como um gatilho entre dois aplicativos que notificam os usuários quando um determinado evento acontece.

Por exemplo, digamos que você queira saber toda vez que um novo card é criado no Pipefy para que você possa obter as informações deste card e utilizá-las no seu software.

Se você estivesse simplesmente usando a API, teria que perguntar constantemente ao Pipefy se um novo card havia sido criado. Caso você não pedisse as informações, nunca saberia. Essa não é uma boa maneira de integrar, pois você teria que enviar solicitações ao Pipefy a cada segundo, e a resposta seria frequentemente "não".

O uso de um Webhook, por outro lado, torna essa interação mais eficiente, notificando você sempre que houver um novo card no Pipefy, enviando um alerta para informar isso. Esse alerta seria usado para fazer com que o seu software solicitasse as informações do card ao Pipefy, e a resposta seria sempre "sim".

Uma API, portanto, é usada para fazer perguntas diretas ou enviar solicitações, enquanto um Webhook é usado como um gatilho para alertar seu software sobre um evento. Em vez de perguntar repetidamente se algo mudou, você pode apenas esperar para ser notificado quando o evento acontecer.

📣 Importante: o Pipefy pode enviar o alerta de Webhook sempre que os eventos abaixo são ativados dentro da aplicação:

  • "Card.create"

  • "Card.done"

  • "Card.expired"

  • "Card.late"

  • "Card.move"

  • "Card.overdue"

  • "Card.field_update"

  • "User.invitation_sent"

  • "User.invitation_acceptance"

  • "User.role_set"

  • "User.removal_from_org"

Faça parte da Comunidade do Pipefy para compartilhar sua opinião sobre nosso produto, tirar dúvidas e ficar por dentro das novidades. Aprenda a utilizar todas funcionalidades da nossa plataforma nos cursos gratuitos da Pipefy Academy.

Conteúdos relacionados:

Respondeu à sua pergunta?