Overview
A webhook sends a message from Appical to another system the moment something happens to a user. For example when they are invited, reach their first day, or complete a course or form. Appical sends an HTTP request with a JSON body to a URL the organisation chooses.
Example
Your organisation wants its HR system to receive an update when a new hire completes their onboarding course. You can create a Webhook with the course.completed Trigger to automatically send this information.
📌 Important
Webhooks need to be enabled for your organisation. If you do not see Webhooks under Settings, please contact your CSM or Appical Support.
Only users with the Admin role can see and manage the Webhooks.
Steps to set up a Webhook
Users with the Admin role set up webhooks under Settings > Webhooks. Other roles do not see this menu item.
→ Create a Webhook
Go to Settings > Webhooks
Click add Webhook.
Fill in the fields (see table below):
Name
Description
Method
URL
Triggers
Signing Secret
Custom headers
Click Create. The Webhook is enabled immediately after it has been created.
→ Add the Webhook details
Field | Required | What to enter |
Name | Mandatory | A recognisable label, e.g. "HR system – Course completion". Max 255 characters. |
Description | Optional | Optional free text explaining what the Webhook is used for. Max 500 characters. |
Method | Mandatory | The HTTP method the receiving system expects. POST is selected by default. See Webhook Methods and Triggers explained for guidance on choosing one. |
URL | Mandatory | The receiving address, starting with http:// or https://. Must be reachable from the internet. |
Triggers | Mandatory | One or more events that should trigger the Webhook. See Webhook Methods and Triggers explained for the full list. |
Signing Secret | Optional | Optional. A secret you create and share with the receiving system, so it can verify requests came from Appical. Never shown again after saving. See Verifying Webhook signatures in Appical for details. |
Custom headers | Optional | Optional name/value pairs added to every request, such as authentication information the receiving system requires. |
📌 Note: Not sure which Method or Trigger to select? See our article Webhook Methods and Triggers explained.
→ Create the Webhook
Check that your configuration is correct, then click Create. The Webhook is enabled immediately after it has been created.
📌 Important: Events are only sent for actions that happen after the Webhook has been created and enabled. Previous events are not sent retroactively.
→ Manage an existing Webhook
Go to Settings > Webhooks. From here, you can:
Use the Enabled toggle to pause or enable a Webhook.
Use the pencil icon to edit a Webhook.
Use the bin icon to delete a Webhook.
📌 Note: Events that happen while a Webhook is disabled are not sent later when you enable it again. Deleting a Webhook also deletes its Delivery History.
👉 Let us know if this article answered your question by using the buttons below. If not, get in touch with our Support Channel for more information: