Almost all events that occur in vPlan are available as webhook events. Webhooks are a way to enable real-time communication and data exchange between different applications. A webhook is a request sent automatically from an application or service to a specific URL (endpoint) when a particular event or action occurs.
In short, vPlan webhooks enable other applications to receive real-time notifications about important events, such as card creation, changing a status or adding a label, enabling seamless integrations and actions between different systems.
As an administrator in vPlan, you can easily set up webhooks. To do so, follow these steps:
Go to Settings in the left menu bar of vPlan.
Click Developers in the left menu bar.
To the right of the Webhooks heading, click on the plus icon.
Give your webhook a name.
Enter a URL where your webhooks will be sent to.
Finally, select which vPlan events to send a message for. You can select multiple events.
Click Save at the bottom of the page.
If you want to activate the webhook, scroll up and click Activate.
From then on, webhook messages will be sent to your specified endpoint based on the events you selected in vPlan.
Tip
We recommend always responding with an HTTP 2XX response to properly received webhooks first, and only then process the message. If vPlan does not receive an HTTP 2XX response, a message is marked as failed. This may affect your webhook continuity.
This same view now also displays a log of all of vPlan's attempts to send messages. Each message has one of the statuses Started, Failed or Successful. You can also click the status button to see the contents of the webhook message.
Messages can also have the status Suspended. This means that vPlan has not had a response from the receiving party that the message was received for some space of time. After 250 failed messages, the vPlan administrator gets an e-mail notification. After 500 failed messages, your webhook will be disabled.