List of Events
When configuring a webhook, you can choose the events for which you would like to receive payloads. In order to limit the number of HTTP requests we send to your servers, only subscribe to the specific events you plan on handling. This will minimize unnecessary information and clutter on your servers.
The following webhook events are currently available:
Event Name | Key | Occurs when... |
---|---|---|
All Employee Forms Received | employee.all_forms_received | An employee has submitted all required forms assigned to them. |
All Employee Forms Received, Accepted, and Countersigned | employee.all_submissions_finalized | An employee has submitted all assigned forms (including optional), and they have been accepted by an administrator and countersigned if necessary. |
All Required Employee Forms Received, Accepted, and Countersigned | employee.all_required_submissions_finalized | An employee has submitted all required forms, and they have been accepted by an administrator and countersigned if necessary. |
Form Submission Accepted by Administrator | employee.submission_accepted | An administrator accepts a form submission. |
Form Submission Rejected by Administrator | employee.submission_rejected | An administrator rejects a form submission. |
Form Submission Countersigned by Administrator | employee.submission_countersigned | An administrator countersigns a form submission. |
Form Submission Internal Fields Updated by Administrator | employee.submission_internal_fields_updated | An administrator modifies internal field values for a form submission. |
E-Verify Case Details Updated | employee.everify_case_updated | An E-Verify case is updated. |
Employee Profile Updated | employee.profile_updated | An employee's profile is updated either by themself or by an admin. It is not called when an employee is created. |
I9 Expiring Documents | employee.submission_expiring_documents | An employee's EAD (option 4 citizenship) will expire in 30 days. If it is submitted with an expiration date less than 30 days from submission, the webhook triggers immediately. |
Form I-9 Reverified | employee.submission_reverified | An employee reverifies their Form I-9. |
Form I-9 Restarted by Staff | employee.i9_restarted | An employee restarts their I-9 after an auth rep labels their documents as Mismatched. |
Employee Submitted a Form | employee.form_submitted | An employee submits a form. This can be tailored to trigger with only a specific form or all forms. |
One endpoint, or many? It's up to you.
One URL endpoint receiving all webhooks: will need to be configured to rely on the webhook headers and/or payload data to distinguish between events and handle each appropriately.
Many URL endpoints receiving one webhook each: the endpoints won't need to distinguish between events and can handle as is.
Updated 4 months ago