Webhook

Schema

Name / Description Type / Format Example
webhookEvent string "Employee_Created" "Employee_Updated" "Employee_Deleted" "Payrun_Finalised" "Payrun_StateChanged" "PensionMembership_Created" "PensionMembership_Updated" "PensionMembership_Deleted" "JobCompleted"
url
The Url to which the payload should be sent
 string uri "string"
active
If set to false then this Webhook will not be triggered
 boolean true
eventCount
The number of times this webhook has been triggered
 integer int32 0
lastPayload WebhookPayload {WebhookPayload}
id
The unique id of the object
 string uuid "string"

JSON Example 

{
  "webhookEvent": "Employee_Created",
  "url": "string",
  "active": true,
  "eventCount": 0,
  "lastPayload": {
    "name": "string",
    "url": "string",
    "attempts": 0,
    "statusCode": 0,
    "taskStatus": "Queued",
    "statusMessage": "string",
    "created": "2024-11-21",
    "payload": {},
    "id": "string"
  },
  "id": "string"
}

References

Contained in Models

- none -

Consumed by Operations
Create Webhook
Update Webhook
Returned by Operations
Get Webhook
Update Webhook
Introduction Webhooks