System | Webhooks

Updated 2026-01-30 00:20:56 UTC Created 2022-06-01 01:25:14 UTC

Overview

Webhooks are a simple way for online systems to "speak" to each other and get notified automatically when an event occurs.

There are two main ways apps communicate to share information: polling and webhooks. Polling uses a pull model (one system asks for updates), while webhooks use a push model (a system pushes updates as they happen). Webhooks are triggered automatically when an event occurs.

Webhooks vs APIs

What is an API?

An API (Application Programming Interface) is a software intermediary that allows two applications to talk to each other. It defines the methods and data structures used for communication between systems.

How Webhooks Differ from APIs

Webhooks work by calling API endpoints. An API provides the location and format for data exchange, while a webhook sends a data payload to an API endpoint when an event occurs in the source system.

Webhooks in Easy Employer

Webhooks are not enabled by default in Easy Employer. To activate webhook functionality, your organisation’s system owner must contact Easy Employer Support.

Webhooks in Easy Employer can be triggered by the following event types:

  • User Events:
    • Create User
    • Update User
    • User pay updated
    • Rule changed
    • User group created
    • User group deleted
  • Timesheet Events:
    • Clock On
    • Clock Off
    • Clock Start Break
    • Clock End Break
    • Actual Shift Updated
    • Timesheet Finalised
  • Leave Events:
    • Leave Created
    • Leave Updated
    • Leave Deleted
    • Leave Shift Create
    • Leave Shift Update
    • Leave Shift Delete
  • Roster Events:
    • Roster published
    • Published roster shift updated
    • Published unassigned roster shift updated
    • Roster shift created
    • Roster shift updated
    • Roster shift deleted
    • Roster template shift created
    • Roster template shift updated
    • Roster template shift deleted
    • Roster template unassigned shift created
    • Roster template unassigned shift updated
    • Roster template unassigned shift deleted
    • Roster shift communicated
    • Roster unassigned shift communicated
  • Entitlement Events:
    • Balances updated
  • Group Events:
    • Group created
    • Group updated
    • Group deleted
    • User-Group created
    • User-Group deleted
  • Payroll Events:
    • Payroll file generated
  • Ability Events:
    • Ability created
    • Ability updated
    • Ability deleted
    • User linked to an ability
    • User ability link updated
    • User unlinked from an ability
  • Appointment Events:
    • Appointment created
    • Appointment updated
    • Appointment deleted
    • Appointment group created
    • Appointment group updated
    • Appointment group deleted
    • Appointment linked
    • Appointment unlinked
    • Billing item created
    • Billing item updated
    • Billing item deleted

Webhook Subscriptions

To subscribe to webhook events in Easy Employer:

  1. Click Organisation in the navigation bar.
  2. Select Integrations.
  3. Click Webhooks in the sidebar.
  4. From here, you can Add, Edit, or Delete webhook subscriptions.
  5. Click Test after adding or editing a subscription to verify connectivity. This sends sample data to your configured URL.
     

Limitations

NOTE: Webhooks are only sent once. If a delivery fails (e.g. due to a server error), there is currently no automatic retry mechanism. There is no ETA for this feature.