Healthier Business Group
Home
HB PortalRequest API access
Home
HB PortalRequest API access
X
Instagram
LinkedIn
  1. Webhooks
  • Walk through Healthier Business Group 🔵
  • Heathier Business Portal APIs V2
    • Authentication
      • Get access token
      • Refresh access token
      • Get token info
      • Revoke current token
    • Reference Requests
      • References
        • Get reference detail
        • Download reference PDF
      • List reference requests
      • Create reference request
      • Get reference request
      • Cancel reference request
      • Add referee to request
      • Send reminders
    • Candidate Requests
    • Training Requests
    • OH Requests
    • Practical Training Requests
    • BLS Requests
    • Appraisal Requests
    • Certificate Requests
    • Training Verification Requests
    • Webhooks
      • List webhook endpoints
      • Create webhook endpoint
      • Update webhook endpoint
      • Delete webhook endpoint
      • View webhook call logs
      • Send test webhook
    • Templates
      • List form templates
  • Heathier Business Portal APIs V1 - Deprecated
    • Candidate Requests
      • Get All Candidates
      • Get Candidate Data
      • Create New Candidate
      • Update Candidate Details
    • Training Requests
      • Get Available Trainings
      • Get Candidate Course Result
      • Get Candidate Training Report
      • Get Candidate Training Report - Unassigned
    • OH Requests
      • Get Available Forms
      • Get Form Fields
      • Creating a new submission
      • Modifying the details of an existing submission (Upload Documents)
      • Make final form submission (after uploading documents)
      • Get submission list
      • Retrieve submission result details
      • Retrieve the submission result documents for the employer
    • Certificates Requests
      • Get Training Certificate
      • Get Training Certificate - including expired
      • Get Training Certificate - including non-assigned courses, but excluding expired
      • Get Training Certificate - All available courses
      • Get Training Certificate - Specific Course
    • Webhooks
      • Training Completion
        GET
      • Course Completion
        GET
  • HB Services
    • List Interview Bookings
      GET
  • The Direct Training Academy
    • Bookings
      • Get Past Bookings
      • Get Upcoming Bookings
      • Search Bookings by Date
    • Booking Links
      • Search Booking Links
  • Schemas
    • Booking
    • TokenResponse
    • InterviewBooking
    • Pagination
    • BookingInvite
    • ReferenceRequest
    • BookingsResponse
    • Reference
    • BookingLinksResponse
    • ReferenceDetail
    • CreateReferenceRequest
    • RefereeInput
    • Template
    • WebhookEndpoint
    • CreateWebhookEndpoint
    • UpdateWebhookEndpoint
    • WebhookCall
    • WebhookPayload
    • PaginationMeta
    • PaginationLinks
    • Error
    • RateLimitError
    • ValidationError
  1. Webhooks

Course Completion

GET
/
Maintainer:Not configured
Course/Module Completion Webhook call will be sent each time when any of your candidates completes any assigned module from their assigned trainings.
This webhook will send a POST/PATCH request (whichever available with OPTIONS) with api-key & api-version headers and following raw json data.
{
    "course": {
        "candidate_ref": "a35691f0-12a0-4f3d-9b24-da8c5492a258",
        "candidate_id": "XXXXXX",
        "course_id": "7",
        "course_name": "Health, Safety and Welfare",
        "date_assigned": "2021-11-18 09:57:43",
        "date_completed": "2021-12-01 01:42:59",
        "renewal_date": "2022-12-01 01:42:59",
        "course_status": "pass",
        "grade": 0.8
    }
}
Client can chain the other HB Api calls with this webhook requests.

Request

Authorization
Add parameter in header
API-Key
Example:
API-Key: ********************

Request Code Samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET '/' \
--header 'API-Key: <api-key>'

Responses

🟢202Training Completion
text/plain
Modified at 2026-02-10 16:10:38
Previous
Training Completion
Next
HB Services
Built with