Estimated reading time: 3 minutes

Webhooks are an easy and efficient way for one software to alert another software.

When using webhooks, you'll be automatically notified when a certain event takes place so you do not have to continuously check the software for that information.

What is a webhook?

A webhook is how an API can alert another API or software. It works as a trigger between two applications that notifies users when a certain event (not due to direct action from the app) happens.

For example, let's say you want to know every time a new card is created on Pipefy so you can get the information on that card for your software.

If you were simply using the API, you'd have to constantly ask Pipefy if a new card has been created. If you didn't ask for the information, you'd never know. That's not a good way to integrate, seeing that you would have to send requests to Pipefy every second (and the answer would frequently be "no").

Using a Webhook, on the other hand, this interaction is more efficient, notifying you every time there's a new card on Pipefy by sending you an alert telling you that information. This alert would then be used to make your software request the card information from Pipefy (and its answer would always be "yes").

An API, therefore, is used to ask direct questions/send requests while a Webhook is used as a trigger to alert your software of an event. Instead of repeatedly asking if something's changed, you can sit back and wait to be notified when the event happens.

📣 Important: Pipefy can send a Webhook alert whenever the events below are activated within the application:

  • "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"

For details on each of the items listed, visit our developers' page.

Join the Pipefy Community to share your questions and exchange ideas with other users, and take Pipefy Academy courses to learn more about other features of our platform.

Related articles:

Did this answer your question?