Paperwork Submission Event

This endpoint specifies what will be sent to your Paperwork Submission Webhook. Zeal POSTs a request containing a Paperwork Submission Object when paperwork is submitted. You can update and test the webhook URL you want Zeal to hit on the ‘API’ Page of the Zeal Dashboard.

Returns

Doesn’t return anything but rather POSTs a request with a Paperwork Submission Object.

Raw Content Example

Paperwork Submission webhook

{
  "test": true,
  "templateID": "d290f1ee-6c54-4b01-90e6-d701748f0851",
  "submissionID": "d290f1ee-6c54-4b01-90e6-d701748f0851",
  "submission_date": "2023-06-01T12:00:00Z",
  "worker_type": "employee",
  "companyID": "603d0f8f1c4b2a4e28c8f0b4",
  "employeeID": "603d0f8f1c4b2a4e28c8f0b4",
  "contractorID": null,
  "jurisdiction": "VA",
  "fields": {
    "field1": "value1",
    "field2": "value2"
  },
  "paperwork_type": "W4",
  "url": "https://example.com/submission/12345"
}

Introduction

Webhooks

Zeal Components

Companies

Company Onboarding

Reserve Accounts

Customer Accounts (Early Access)

Taxable Locations

Work Locations

Employees

Employee Deduction Templates

Garnishments

Employee Onboarding

Bank Accounts

Custom Attributes

Paperwork API

Employee Checks

Contractors

Contractor Onboarding

Contractor Payment Deductions

Payment Items

Contractor Payments

Paycards

Instant Pay

Employer Checks

Preview

Embedded HR

Reports

Documents

Paperwork Submission Event

Returns

Raw Content Example

​Returns

​Raw Content Example

Returns

Raw Content Example