Adding a Webhook

In this article, you will learn how to set up a webhook in Panel Management so that you can pass data to an external system.

A webhook is a method of communication used in web development. It allows for real-time data transmission between different applications or services over the internet.

Trigger Event: A webhook is set up by a user or developer within an application or service. They define a specific event or action that should trigger the webhook.

Registration: The user provides a URL endpoint where the webhook should send data when the specified event occurs.

Event Occurrence: When the defined event occurs within the source application or service, it sends an HTTP POST request containing relevant data to the URL endpoint specified for the webhook.

Data Transmission: The receiving application or service (which set up the webhook) listens for incoming HTTP POST requests at the specified URL endpoint. When it receives data from the webhook, it can process it accordingly.

Webhooks are commonly used for real-time notifications, data synchronization between different systems, and automation of workflows. They enable seamless integration and communication between various web-based services or applications without the need for continuous polling or manual intervention.

1: How to Add a Webhook

Click on Settings & tools dropdown and select Webhooks.

Click on "Add new webhook" and enter the required information.

URL	A URL that will be used to send webhook data
Events	Events which trigger webhooks to send data Panelist created - Triggered when a new panelist is created Panelist data changed - Triggered when a panelist’s data has been updated or changed Panelist deleted - Triggered when a panelist is deleted Panelist opt-in- Triggered once a panelist confirms their membership after clicking the opt-in link Panelist survey activity- Triggered once survey activity status changed to started, completed, quota Panelist survey invitation - Triggered once panelist has a new invitation to a survey
Enabled SSL verification	Enabled SSL verification
Authentication method	When the "signed" authentication method is used, the payload that is sent to the receiving endpoint is cryptographically signed. The "Authentication method" option can only be selected when the Webhook is being created. Once a Webhook has been created, editing this option is not possible. Selecting the "signed" authentication method will create a key pair and display the public key. This key will only be shown once, so make sure you save it. Please refer to the API documentation for instructions on how to validate the signature.

2: How to Delete, Edit, Test a webhook

Once the webhook has been added, you can edit or test the webhook with the actions buttons next to the webhook.

You can edit the webhook by clicking on the edit icon under the actions column and test the webhook by clicking on the play icon to the left of the Webhook URL. To delete a webhook click on the delete icon under the delete column to the right of the webhook.