How to set up a webhook

What is a webhook?

Webhooks are one way that applications can send automated messages or information to other applications. The messages are sent when something happens (a trigger or event) in the sending application. They contain a message - or payload - that is sent to a unique URL, which the receiving application can process.

How to use webhooks

You may have a third party application or system that needs to ingest or process enrolment data from Palette. One example is a student management system. With a webhook you can send the enrolment data to your student management system to create a new record or update an existing one. The webhooks are triggered whenever an enrolment is made in Palette.

How to setup a webhook

Each system will have different data requirements that is needed, however the data that is sent from Palette is in a consistent format. To setup a new webhook, navigate to 'Settings' => 'Webhooks' and click 'New'.

Enter the following in the text boxes.

• The name to describe that the webhook is for
• The URL of the webhook. This will be provided by the third party application that you are sending the data to.

Once it's created, Palette will automatically create a webhook secret. This may be required on some systems to verify that the data is being sent by a trusted source. You can add the secret to your third party application if this is required.