Webhook Customer Endpoint - API Documentation

This document describes the webhook-based integration approaches supported for customer endpoints. These approaches allow customers to securely receive job-related payloads from the LaborEdge platform.

Currently, two approaches are supported:

1. Two-Step Authentication + Webhook Configuration
2. Pre-Signed Webhook URL with Access Token

Both approaches are designed to ensure secure communication using access tokens.

Step 1: Generate Access Token

An API is provided to generate an access token. This token must be used as a Bearer Token while invoking the webhook endpoint.

• This endpoint will be secured as per integration-specific authentication (shared separately).

{
  "access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
}

Step 2: Configure Webhook Endpoint

Once the access token is generated, the webhook endpoint must be configured to receive job-related events.

Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...
Content-Type: application/json

{"status": 200, "failureMessage": ""}
{"status": 401, "failureMessage": "Invalid authentication details provided"}

• The webhook endpoint will be invoked by LaborEdge.
• The Bearer token obtained from Step 1 must be included in the Authorization header.

In this approach, the webhook URL itself contains the access token as a path parameter. This simplifies webhook configuration by eliminating the need to manage headers dynamically.

Webhook Endpoint Configuration

{"status": 200, "failureMessage": ""}
{"status": 401, "failureMessage": "Invalid authentication details provided"}

• The access token is embedded directly in the endpoint URL.
• This endpoint can be configured directly as a webhook.
• No Authorization header is required unless explicitly agreed.

The webhook payload will be sent as a JSON request body. The structure of the payload depends on the integration and event type and will be shared separately as part of the integration contract.

• Tokens should be stored securely and never exposed publicly.
• For Approach 2, ensure the webhook URL is not logged or shared externally.

For token credentials, payload schemas, or integration-specific questions, please contact the LaborEdge integration support team.

Sample Payload - Travel Job Type

{
  "Client Name": "Denver Medical Center",
  "Job Posting Id": 4133,
  "Job Type": "TRAVEL",
  "Status": "Open",
  "Hot Job": true,
  "Position Urgency": "NORMAL",
  "Offering": "ALLIED",
  "Sub Offering": "REHAB",
  "Profession": "OT",
  "Specialty": "OT",
  "Job Title": "Radiology MRI",
  "VMS Job Board URL": "",
  "Display on External Job Board": "Enable",
  "Display On Indeed": "Yes",
  "Job Qty": 2,
  "Shift": "07:00AM-03:00PM",
  "Start Date": "08/19/2024",
  "ASAP": "No",
  "Assignment Length": 13,
  "Duration Type": "WEEKS",
  "End Date": "11/13/2024",
  "VMS": "NVMS",
  "Computer Charting": "McKesson",
  "Setting": "Hospital",
  "NBO Hours": "",
  "Additional Information": "",
  "Job Description": "Occupational therapists treat disabled, ill or injured patients with special equipment and the therapeutic use of daily activities.",
  "Sales Representative": "",
  "Staffing Specialist": "",
  "Floating Required Units": "Sample Floating required text",
  "Amount Call Required": "Sample call Required text",
  "Preferred Certifications": "",
  "Bill Rate": 1,
  "High Bill Rate": null,
  "> 8 Bill Rate": null,
  "> 12 Bill Rate": null,
  "37-40 Bill Rate": null,
  "> 40 Bill Rate": null,
  "> 48 Bill Rate": null,
  "> 60 Bill Rate": null,
  "On Call Bill Rate": null,
  "Charge Bill Rate": null,
  "Call Back Rate": null,
  "Holiday Rate": null,
  "Show Location City ?": "",
  "City Alias": "",
  "Client Type": "Direct",
  "MSA": "",
  "Auto Offer": 1,
  "Bonus": 0.00,
  "City": "Salem",
  "Department": "X-RAY",
  "Featured": 1,
  "MSP": "AMN",
  "Recruiter": "William Ana",
  "Salary Maximum Bill Rate": null,
  "Salary Minimum Bill Rate": null,
  "Salary High Pay Rate": null,
  "Salary Low Pay Rate": null,
  "Custom Shift": "Yes",
  "Custom Shift Start Time": "07:00",
  "Custom Shift End Time": "15:00",
  "Custom Shift Scheduled Hours": 40.00,
  "Custom Shift Shifts Per Week": 5
}

Sample Payload - Per Diem Job Type

{
  "Client Name": "Denver Medical Center",
  "Job Posting Id": 4133,
  "Job Type": "PERDIEM",
  "Status": "Open",
  "Hot Job": true,
  "Position Urgency": "NORMAL",
  "Offering": "ALLIED",
  "Sub Offering": "REHAB",
  "Profession": "OT",
  "Specialty": "OT",
  "Job Title": "Radiology MRI",
  "VMS Job Board URL": "",
  "Display on External Job Board": "Enable",
  "Job Qty": 2,
  "Shift": "07:00AM-03:00PM",
  "Order Date": "08/19/2024",
  "VMS": "NVMS",
  "Computer Charting": "McKesson",
  "Setting": "Hospital",
  "NBO Hours": "",
  "Additional Information": "",
  "Job Description": "Occupational therapists treat disabled, ill or injured patients with equipment and the therapeutic use of daily activities.",
  "Sales Representative": "",
  "Staffing Specialist": "",
  "Floating Required Units": "Sample Floating required text",
  "Amount Call Required": "Sample call Required text",
  "Preferred Certifications": "",
  "Bill Rate": 1,
  "High Bill Rate": null,
  "> 8 Bill Rate": null,
  "> 12 Bill Rate": null,
  "37-40 Bill Rate": null,
  "> 40 Bill Rate": null,
  "> 48 Bill Rate": null,
  "> 60 Bill Rate": null,
  "On Call Bill Rate": null,
  "Charge Bill Rate": null,
  "Call Back Rate": null,
  "Holiday Rate": null,
  "Show Location City ?": "",
  "City Alias": "",
  "Client Type": "Direct",
  "MSA": "",
  "Auto Offer": 1,
  "Bonus": 0.00,
  "City": "Salem",
  "Department": "X-RAY",
  "Featured": 1,
  "MSP": "AMN",
  "Recruiter": "William Ana",
  "Orientation": "NO",
  "Primary Specialty": "OT -> OT"
}

Sample Payload - Permanent Job Type

{
  "Client Name": "Southwest Medical Center - TRS",
  "Start Date": "06/01/2026",
  "Status": "Open",
  "Shift": "9 HR Days, 07:00:00-16:00:00, 9.00-4",
  "Division": "Radiology / Sonography",
  "Offering": "Radiology / Sonography",
  "Profession": "Radiology / Sonography",
  "Sub Offering": "Radiology / Sonography",
  "Specialty": "CT Tech",
  "Additional Information": "ID: 62897733 Shift: 36 Hours Per Week",
  "Bill Rate": 0,
  "Salary Maximum Bill Rate": "0.0000",
  "Job Posting Id": "18778",
  "On Call Bill Rate": 0,
  "Call Back Rate": 0,
  "Holiday Rate": 0,
  "Job Type": "Perm",
  "Job Qty": "1",
  "VMS": "Conexus",
  "State Code": "Kansas",
  "City": "Liberal",
  "Zip": "67901",
  "Bonus": "0.0000",
  "Sign on Bonus": "0.0000",
  "OT Rate": 0,
  "Hot Job": "No",
  "Show Location City ?": "Yes",
  "Association": "",
  "ASAP": "No",
  "Charge Bill Rate": 0,
  "VMS Job Board URL": "https://app.centrafi.net/Login/Details.aspx",
  "Job Title": "Radiology / Sonography - CT Tech",
  "Sales Representative": "Select-Value",
  "Position Urgency": "",
  "Preferred Certifications": "",
  "Salary Low Pay Rate": "0.00",
  "Salary High Pay Rate": "0.00",
  "Salary Minimum Bill Rate": "0.00",
  "NBO Hours": "",
  "Display on External Job Board": -1,
  "Display On Indeed": "No",
  "Recruiter": "",
  "Department": "",
  "Auto Offer": 0,
  "Featured": -1,
  "Setting": "",
  "Computer Charting": "",
  "> 8 Bill Rate": "",
  "> 12 Bill Rate": "",
  "37-40 Bill Rate": "",
  "> 48 Bill Rate": "",
  "> 40 Bill Rate": 0,
  "MSP": "",
  "Client Type": "VMS",
  "MSA": "Yes",
  "Agency": "Axis",
  "Staffing Specialist": "Select-Value",
  "Placement Fee": "",
  "Placement fee type": "",
  "Relocation Package": "",
  "> 60 Bill Rate": "",
  "Custom Shift": "Yes",
  "Custom Shift Start Time": "07:00",
  "Custom Shift End Time": "15:00",
  "Custom Shift Scheduled Hours": 40.00,
  "Custom Shift Shifts Per Week": 5
}

"Custom Shift" Configuration Notes

• Applicable only to TRAVEL and PERM job types.
• When Custom Shift is set to true, Custom Shift Start Time, Custom Shift End Time, Custom Shift Scheduled Hours and Custom Shift Shifts Per Week should be provided.
• These fields are not applicable to PERDIEM jobs and may be omitted.