Webhooks

Working with Check's webhooks

Given the asynchronous nature of payroll software, it is critical for developers to have a fully observable view of the platform on which they are building. Check allows developers to bypass the need to constantly poll the Check API for updates and instead provides webhooks for all of its critical API resources, sending you real-time updates about the status of these objects. Once configured, your webhooks and their delivery attempts will be summarized in the Check Console under the ‘Developer’ tab.

What is a Webhook

A webhook provides the ability for one application to update other applications with real-time information on platform activities. In Check's case, this could mean a payroll going from 'processing' to 'paid' or an employee submitting a tax document through Check Onboard.

Why Use a Webhook

The function of webhooks is to connect two different applications and send serialized data based on event updates, removing the need to constantly poll the Check API to look for changes. Webhooks are especially important when dealing with asynchronous events such as the lifecycle of a payroll and the changes in an employee’s onboarding status.

Use Check API's webhooks to automatically receive HTTP updates when a payroll state changes, an employee updates their information, bank information is changed, or other updates are posted to your Check integration.


Did this page help you?