What is a Webhook?
A webhook is a way for Cloud Assess to automatically notify another application when something happens in your account.
Instead of another system repeatedly checking Cloud Assess for updates, a webhook sends information instantly when a selected event occurs. This allows different systems to stay in sync without manual intervention.
Think of it like a doorbell:
Without a webhook: Someone has to keep knocking on your door to see if you're home.
With a webhook: The doorbell rings as soon as someone arrives.
The same idea applies to Cloud Assess. Rather than another system constantly asking if something has changed, Cloud Assess sends a notification as soon as the event occurs.
Why Use Webhooks?
Webhooks can help automate your processes by notifying other systems when important events occur.
Common uses include:
Updating an external Student Management System (SMS)
Triggering workflows in automation platforms such as Zapier or Microsoft Power Automate
Sending notifications to internal systems
Creating custom reports
Integrating Cloud Assess with your own applications
How Webhooks Work
The process is simple:
An event occurs in Cloud Assess.
Cloud Assess sends a secure HTTP request to a URL that you've configured.
Your receiving application processes the information.
The receiving system performs whatever action you've programmed it to do.
For example:
A learner submits an assessment.
↓
Cloud Assess sends a webhook.
↓
Your automation receives the data.
↓
A notification is sent to a trainer.
Common Events
Depending on your configuration, webhooks can notify external systems when events such as the following occur:
Learner created
Learner updated
Enrolment created
Enrolment updated
Assessment submitted
Assessment marked
Unit outcome updated
Certificate issued
The available webhook events may vary depending on your Cloud Assess configuration.
What Information is Sent?
When a webhook is triggered, Cloud Assess sends a JSON payload containing information about the event.
For example, a webhook may include:
Learner ID
Learner name
Enrolment ID
Unit ID
Assessment ID
Outcome
Date and time of the event
The exact information depends on the webhook event.
Before You Get Started
You'll typically need:
An application that can receive webhooks
A webhook endpoint (URL)
Basic knowledge of APIs or someone who manages your integrations
Administrator access to Cloud Assess
Security
Webhooks send data to the URL you provide, so it's important to:
Only use trusted endpoints.
Protect your endpoint with appropriate authentication where possible.
Use HTTPS to encrypt data during transmission.
Regularly monitor your integrations for unexpected behaviour.
Testing Your Webhook
Before using a webhook in production, it's a good idea to test it.
You can:
Verify the endpoint is reachable.
Confirm the receiving application accepts the payload.
Check that your automation behaves as expected.
Review any logs for errors.
Troubleshooting
My webhook isn't triggering
Check that:
The webhook is enabled.
The correct event has been selected.
The event has actually occurred.
The destination URL is correct.
Your receiving server is online.
My receiving system isn't processing the webhook
Check that:
Your endpoint accepts HTTP POST requests.
Your application can process JSON data.
Authentication requirements are configured correctly.
Your server logs for any errors.
I'm not receiving any data
Verify that:
The webhook URL is accessible from the internet.
Your firewall isn't blocking incoming requests.
SSL certificates are valid.
The receiving service is responding successfully.
Frequently Asked Questions
Do webhooks change data in Cloud Assess?
No. Webhooks only send information when an event occurs. They don't make changes to your Cloud Assess data.
Are webhooks real-time?
Yes. Webhooks are sent almost immediately after the selected event occurs.
Do I need programming experience?
If you're connecting Cloud Assess to an existing automation platform such as Zapier, little or no coding may be required. For custom integrations, some technical knowledge is recommended.
Can I have multiple webhooks?
Yes. You can configure multiple webhook endpoints for different integrations, depending on your implementation.
Next Steps
Once you're familiar with how webhooks work, you can:
Configure webhook endpoints.
Connect Cloud Assess to your existing systems.
Build custom automations.
Create real-time integrations with your business applications.
Webhooks are a powerful way to automate repetitive tasks and keep your systems up to date with minimal manual effort.