Webhooks & Data Transfer During Setup and Maintenace
Understand how webhooks facilitate real-time data transfer between Check Console and your payroll product.
Overview
This article explains how your payroll product and Check Console work together, especially when you use Check Embedded Setup. It covers what webhooks are, when Check triggers them during setup, and which webhook events Partners typically consume.
Partner differences
What are webhooks?
Webhooks send real-time notifications from Check to your product whenever a tracked event occurs—for example, a payroll status change or an Employee submitting a tax document through Check Onboard.
Why use webhooks in setup?
Webhooks ensure that data created in Console—whether by Check teams or Partner teams—appears in your payroll product.
Example: A Check setup specialist adds a terminated Employee so year-to-date wages are complete. That action fires a employee.created webhook. Your application receives the event and displays the Employee in your UI. Without the webhook integration, the Employee would exist only in Console.
Webhook event types
Event type | Description |
created | A record is added |
updated | A record is edited |
deleted | A record is removed |
Common webhook categories for setup
Company | Payroll |
Employee | Bank account |
Contractor | Employee tax |
Workplace | Post-tax deduction |
Earning code | Benefit |
Earning rate | Company tax |
Check with your engineering team to confirm which webhook categories your product currently handles.
FAQs
Why do I see an Employee in Console but not in my product?
The relevant webhook may have failed or your product does not yet consume that event. Ask your R&D team to review the webhook logs and integration.
Recording
Last updated on June 30, 2024