Webhook Event Types

A list of Check supported webhook events

Check-Topic header

Each webhook request has a Check-Topic header that represents which type of API event the webhook is associated with.

Topic

Description

payroll

Any payroll lifecycle event

company_tax_document

Any company tax document event

company_authorization_document

Any company authorization document event

employee_tax_document

Any employee tax document event

contractor_tax_document

Any contractor tax document event

bank_account

Any bank account event

benefit

Any benefit event

post_tax_deduction

Any post-tax deduction event

company

Any company event

employee

Any employee event

contractor

Any contractor event

workplace

Any workplace event

earning_code

Any earning code event

Payroll Events

Event

Description

status_change

A payroll instance's status changes (for example, a payroll moves from pending to processing).

Example webhook event payload

{
    "event": "status_change",
    "data": {
        "id": "pay_XxDn3NhEzlWQZWMTF6OP",
        "company": "com_jq1rtsUR1BRRJOWzQb8E",
        "approved_at": "2020-08-06T19:47:51.697867Z",
        "status": "processing",
        ... // remainder of payroll data
    }
}

More detail on the Payroll object.

Document Events

These events apply to employee, company, and contractor document resources.

Event

Description

created

A document was created (For example, this could be triggered when an employee submits a document through Check Onboard)

Example webhook event payload
Here is an example webhook event payload for an employee tax document:

{
    "event": "created",
    "data": {
        "id": "doc_oSFuU4veTPqG8KRGAINc", 
        "year": 2021,
        "category": "employee_tax_document",
        "label": "Federal W-4", 
        "employee": "emp_jMjjmrBTSNzBCG1kRkh9", 
        "filed_on": "2021-02-18", 
        "jurisdiction": "FED"
    }
}

More detail on the Document object (and the various document categories).

Bank Account Events

Event

Description

created

A bank account was created

updated

A bank account was updated

deleted

A bank account was deleted

Example webhook event payload

{
    "event": "created",
    "data": {
        "id": "bnk_BcuzUyfy6Rt2Woa6TAHz",
        "company": "com_cHVEOcdE6bzMiBxpOzTQ",
        "plaid_bank_account": {
            "name": "Plaid Checking",
            "plaid_public_token": "public-sandbox-023e3f0d-bcd8-46ee-b1dd-fcb67bcb4372",
            "institution_name": "Chase",
            "mask": "0000",
            "type": "depository",
            "subtype": "checking",
            "verified": true,
            "microdeposit_verification_status": null
        }
    }
}

More detail on the Bank Account object.

Benefit Events

Event

Description

created

A benefit was created

updated

A benefit was updated

deleted

A benefit was deleted

Example webhook event payload

{
    "event": "created",
    "data": {
        "id": "ben_x3BTJJjgRCHDRTffYUAJ",
        "benefit": "401k",
        "employee": "emp_SXRWvWC6TYtZLHpCYxOi",
        "description": "Retirement",
        "effective_end": null,
        "effective_start": "2021-03-26",
        "hsa_contribution_limit": null,
        "company_contribution_amount": "1.00",
        "company_contribution_percent": null,
        "employee_contribution_amount": "1.00",
        "employee_contribution_percent": null
    },
}

More detail on the Benefit object.

Post-Tax Deduction Events

Event

Description

created

A post tax deduction was created

updated

A post tax deduction was updated

deleted

A post tax deduction was deleted

Example webhook event payload

{
    "event": "created",
    "data": {
        "id": "ptd_g4AGCxtz8VakIL4PmZ0r",
        "type": "miscellaneous",
        "employee": "emp_bvNhcPxrbvRqgyCrlUcj",
        "description": "Union dues",
        "effective_start": "2020-01-01",
        "effective_end": null,
        "miscellaneous": {
            "amount": "10.00",
            "percent": null,
            "total_amount": "50.00"
        }
    }
}

More detail on the Post-Tax Deduction object.

Company Events

Event

Description

created

A company was created

updated

A company was updated

deleted

A company was deleted

Example webhook event payload

{
    "event": "created",
    "data": {
        "id": "com_sx3svU6K8c5ZkSFlOh5p",
        "legal_name": "Stark Industries, Inc.",
        "trade_name": "Stark Industries",
        "email": "[email protected]",
        "phone": "5551234567",
        "pay_frequency": "biweekly",
        ... // remainder of company object
    }
}

More detail on the Company object.

Employee Events

Event

Description

created

An employee was created

updated

An employee was updated

deleted

An employee was deleted

Example webhook event payload for an employee

{
    "event": "created",
    "data": {
        "id": "emp_zGGp6wYcxAeu1Ng8IA7v",
        "first_name": "Tony",
        "last_name": "Stark",
        "middle_name": null,
        "email": "[email protected]",
        "dob": "1970-05-29",
        ... // remainder of employee object
    }
}

More detail on the Employee object.

Contractor Events

Event

Description

created

A contractor was created

updated

A contractor was updated

deleted

A contractor was deleted

Example webhook event payload for a contractor

{
    "event": "created",
    "data": {
        "id": "ctr_CyQIKSp6YvU6mBe2a6iq",
        "type": "individual",
        "company": "com_EkIJ9RewumnQLODHv1vl",
        "first_name": "Bruce",
        "middle_name": "Frederick Joseph",
        "last_name": "Springsteen",
        "business_name": null,
        "email": "[email protected]",
        ... // remainder of contractor object
    }
}

More detail on the Contractor object.

Workplace Events

Event

Description

created

A workplace was created

updated

A workplace was updated

deleted

A workplace was deleted

Example webhook event payload for a workplace

{
    "event": "created",
    "data": {
        "id": "wrk_oRgjEaRycoCPuS5TqVkm",
        "name": "New York Office",
        "address": {
            "line1": "200 Park Ave",
            "line2": null,
            "city": "New York",
            "state": "NY",
            "postal_code": "10166",
            "country": "US"
        },
        "company": "com_P7JPeBhb8hH23iiReDQ5"
    }
}

More detail on the Workplace object.

Earning Code Events

Event

Description

created

An earning code was created

updated

An earning code was updated

deleted

An earning code was deleted

Example webhook event payload for an earning code

{
  "event": "created",
  "data": {
    "id": "erc_IR4KiBBB2E6YD2cZjOyn",
    "name": "Sales Commission",
    "type": "commission",
    "company": "com_ccGeW0Etf1UGNPBgQ1Xl"
  }
}

More detail on the Earning Code object.


Did this page help you?