Setting up / Using Webhooks

Use webhooks to be notified about events that happen in a PLNAR account.

Tommy avatar
Written by Tommy
Updated over a week ago

PLNAR can send webhook events that notify your application any time an event happens on your account. This is especially useful for events—like creating, updating, or deleting projects, and new users/customers being added. 

You can register webhook URLs that we will notify any time an event happens in your account. When the event occurs—a project is created by a customer, a update is made to a preexisting project, your account is updated, etc. - PLNAR creates an Event object. 

This Event object contains all the relevant information about what just happened, including the type of event and the data associated with that event. PLNAR then sends the Event object, via an HTTP POST request, to any endpoint URLs that you have defined in your account’s Webhooks settings. You can have PLNAR send a single event to many webhook endpoints.

You might use webhooks as the basis to:

  • Update a customer’s contact information in your database when a user updates their profile

  • Email a customer when a report has been submitted.

  • Examine updated project assets when a change has occured in a report.

  • Identify the total square footage of the most recent project submission

Configuring your webhook settings

Webhooks are configured in the Company Details Webhook & Links section. Click Add Webhook to reveal a form where you can add a new URL for receiving webhooks. 

You can enter any URL as the destination for events. However, this should be a dedicated page on your server that is set up to receive webhook notifications

Common Webhook Mistakes

The two most common mistakes with webhooks are providing the wrong URL in the Dashboard and the webhook endpoint not returning a 200 status code.

Receiving a webhook notification

Creating a webhook endpoint on your server is no different from creating any page on your website.

Webhook data is sent as JSON in the POST request body. The full event details are included and can be used directly, after parsing the JSON into an Event object

HTTPS server requirement

The PLNAR platform requires the use of an HTTPS URL for your webhook endpoint. A security check validates whether or not the connection to your server is secure before sending your webhook data. For this to work, your server must be correctly configured to support HTTPS with a valid server certificate.

Did this answer your question?