Note: Webhooks are used by developers to get notifications from Projectal when certain events occur.  If you are not a developer, then you can skip this section.

Webhooks are automated messages sent by Projectal when something in Projectal happens. They have a message (or payload) and are sent to a unique URL that you choose.

Webhooks are a way for Projectal to provide other applications with real-time information. Projectal can send notifications to another application when a certain event occurs.  

Developers can subscribe to events that occur in Projectal and Projectal will notify immediately using the URL that has been specified.

Event Entities

When creating a webhook, you must choose what entity you wish to get notifications about.  All entities in Projectal are available to be selected - including PROJECT, TASK, STAFF, BOOKING, COMPANY, DEPARTMENT and more.  Go to the New Webhook screen or Edit Webhook screen in Projectal to see the full list.

Event Actions

After selecting the entity that you wish to subscribe to, then you must choose what actions you wish to be notified about. There are 3 actions available - CREATE, UPDATE and DELETE.

Event URLs

Every webhook needs a destination URL so that Projectal can send a notification message to it to let you know that the event has occurred.  The destination URL must be set up by you and must be reachable by your Projectal.  Typically, your Event URL will point to a web server that you are using to receive notifications that are sent by Projectal when the subscribed evens occur in your Projectal.

Example: A developer wishes to monitor when tasks get updated in Projectal so that Slack messages can be sent to the assigned staff's Slack channel.  So the developer will create a webhook for the entity TASK with the action UPDATE and specify a receiving URL - e.g. https://yourwebsite.com/projectal-notification/task-update