For AI agents: visit https://developers.workbright.com/llms.txt for an index of all pages formatted in Markdown and endpoints in OpenAPI.
Jump to Content
WorkBright Developer Hub
HomeGuidesAPI RecipesAPI EndpointsProduct Changelog
Current

Log InWorkBright Developer Hub
Guides
Log In
CurrentHomeGuidesAPI RecipesAPI EndpointsProduct Changelog

Overview

  • Introduction
  • Authentication
  • Responses
  • Rate Limits
  • WorkBright API Agreement
  • List of Endpoints
  • Availability

Webhooks

  • Setup
  • List of Events
  • Payloads
    • Employee Submitted a Form
    • Form Submission Accepted by Administrator
    • Form Submission Rejected by Administrator
    • Form Submission Internal Fields Updated by Administrator
    • Authorized Representative Mismatch on Form I-9
    • Admin Requested a New Form Submission
    • Document Verification Results Marked as Reviewed by Admin
    • Form Submission Countersigned
    • All Employee Forms Received
    • All Employee Forms Received, Accepted, and Countersigned
    • All Required Employee Forms Received, Accepted, and Countersigned
    • E-Verify Case Details Updated
    • E-Verify Authentication Attempted
    • Employee Profile Updated
    • I9 Expiring Documents
    • Form I-9 Reverified
    • Form I-9 Restarted by Staff

Embedded Mode

  • Configuration
  • Recommended Notifications
  • Embedded iframe
  • Embedded Android
  • postMessage API Events
  • Custom App Theming
Powered by 

Introduction

Welcome to the WorkBright API. Our API is REST-based, with predictable, resource-oriented URLs and standard HTTP response codes to indicate results.

Throughout this documentation, and in the cURL examples accompanying the API Endpoints, you will see references to YOUR_SUBDOMAIN and YOUR_API_KEY. As implied, you must replace these placeholders with your actual subdomain and your API key.

Updated 11 months ago


Authentication