Trio Agency API Docs
Trio Agency APIsTrio Client APIs
Trio Agency APIsTrio Client APIs
  1. Trio
  • Trio
    • Home
    • Webhooks
    • Guides
      • Jobs Sync
      • Candidate Submission
    • APIs
      • Candidate
        • Get a list of all active candidates related to your account.
        • Create or update a candidate.
        • Gets information for the specified candidate.
      • Candidates
        • Gets a list of candidates
        • Creates a candidate.
        • Gets a specific candidate
        • Updates a candidate.
      • Client
        • Get a list of all active clients related to your account.
        • Gets information for the specified client.
      • Clients
        • Get client locations.
        • Get a specific client location.
      • Job
        • Gets a listing of all open jobs.
        • Gets a listing of closed jobs based on the date range.
        • Get information for the specified job.
      • Profession
        • Gets all professions with a list of their specialties.
      • ProviderConfirmation
        • Get a list of provider confirmations related to your account.
        • Get information for the specified provider confirmation.
      • Shifts
        • Gets a list of shifts for the user performing the request
        • Gets a list of available shift statuses
        • Gets a specific shift
        • Attempts to claim the shift for the current user or specified candidate
        • Confirms the assignment of a shift
        • Declines the assignment of a shift
        • Releases a confirmed shift
      • ShiftSubmissions
        • Attempts to submit a shift submission
        • Attempts to accept a shift submission
        • Attempts to reject a shift submission
        • Attempts to withdraw a shift submission
      • Specialty
        • Gets all specialties.
        • Gets information for the specified specialty.
      • StaffingPools
        • Get a collection of candidates with active or inactive clearances to staffing pools
        • Get locations for staffing pools
      • Submission
        • Get a list of all submissions related to your account.
        • Create a new submission.
        • Accepts a submission that was offered.
        • Declines an offered submission.
        • Withdraw a submission.
        • Get a list of reasons for withdrawing a submission.
        • Get information for the specified submission.
        • Update the specified submission.
      • Timecard
        • Get a list of all Timecards related to your account.
        • Get a list of all valid Pay Types the can be used when creating/updating Timecard Lines.
        • Get a specific timecard.
        • Get a list of all documents associated with a timecard.
        • Get the timesheet document associated with a timecard.
        • Get a specific document associated with a timecard.
      • Timecard Copy
        • Get a list of all Timecards related to your account.
        • Get a list of all valid Pay Types the can be used when creating/updating Timecard Lines.
        • Get a specific timecard.
        • Get a list of all documents associated with a timecard.
        • Get the timesheet document associated with a timecard.
        • Get a specific document associated with a timecard.
      • TimecardExpense
        • Get a list of all Timecard Expenses for a Timecard.
      • TimecardLine
        • Get a list of all Timecard Lines for a Timecard.
      • Webhooks
        • Get a list of all webhooks registered for your agency.
        • Subscribes a new webhook to a Trio event.
        • Deletes the webhook registration from Trio.
        • Get the list of available events that can be subscribed to via webhook.
        • Get a webhook by its id.
Trio Agency APIsTrio Client APIs
Trio Agency APIsTrio Client APIs
  1. Trio

Webhooks

Trio Agency Webhooks#

In addition to traditional API endpoints for data retrieve, Trio VMS also offers webhooks that are triggered in different scenarios and can be configured to POST payloads to URLs for each event fired.
This allows for a simplified data capture process where updates are pushed from Trio VMS vs constantly pulling data to determine what has updated.
Trio webhooks do NOT currently support authentication when posting content.

Registering for Webhook Events#

As an Agency admin, you can register and manage webhook events through the Trio VMS web application or the API.

Trio VMS Application Webhook Mangement#

Managing Trio VMS webhooks is easiest through the web application, when you can see and edit existing registered webhooks, example payloads, and register new webhooks.
You must have Agency admin permission and can access webhooks through the Manage -> Webhooks menu option.
Webhook Management
Webhook Event

Trio VMS API Webhook Management#

Managment of webhooks can also be done through the /api/v3/webhooks endpoint.
List existing webhook registrations
List available webhook events
Create a new webhook registration.
Update an existing webhook

Webhook Events#

Job Update#

When a job is opened, updated in an Open status, or transitioning to Closed status, the Job Update webhook event will POST a JSON payload that matches the /api/v3/Job/{number} endpoint result.

Submission Update#

When a candidate submission's status changes, the Submission Update webhook event will POST a SubmissionNotification JSON payload.

Non Locums Confirmation Signed#

Documentation coming soon.

Per Diem Shift Events#

Webhook events are produced for actions related to Per Diem Shifts for shifts that your agency is able to see.
Important - Start and End datetimes for shifts are in the local time for the Staffing Pool they are associated with.

Per Diem Shift Opened#

When one or more Per Diem Shifts are opened/posted for qualified clinicians to claim, the Per Diem Shift Opened event will POST a PerDiemShiftOpenedNotification JSON payload.

Per Diem Shift Assigned#

When a Per Diem Shift is assigned to a clinician working through your agency, the Per Diem Shift Assigned event will POST a PerDiemShiftAssignedNotification JSON payload.

Per Diem Shift Confirmed#

When a Per Diem Shift assigned to a clinician working through your agency is confirmed, the Per Diem Shift Confirmed event will POST a PerDiemShiftConfirmedNotification JSON payload.

Per Diem Shift Cancelled#

When one or more Per Diem Shifts assigned to a clinician working through your agency are cancelled, the Per Diem Shift Cancelled event will POST a PerDiemShiftCancelledNotification JSON payload.

Per Diem Shift Removed#

When a Per Diem Shift is no longer available for qualified clinicians working through your agency to claim, the Per Diem Shift Removed event will POST a PerDiemShiftRemovedNotification JSON payload.

Per Diem Shift Released#

When a Per Diem Shift claimed by a clinician working through your agency releases a shift they had, the Per Diem Shift Released event will POST a PerDiemShiftReleasedNotification JSON payload.

Per Diem Shift Declined#

When a Per Diem Shift assigned to a clinician working through your agency declines a shift that was assigned to them, the Per Diem Shift Declined event will POST a PerDiemShiftDeclinedNotification JSON payload.

Per Diem Shift Staffing Pool Changed#

When the staffing pool for a Per Diem Shift is changed, the Per Diem Shift Staffing Pool Changed event will POST a PerDiemShiftStaffingPoolChangedNotification JSON payload.

Per Diem Shift Location Changed#

When the facility or unit for a Per Diem Shift is changed, the Per Diem Shift Location Changed event will POST a PerDiemShiftLocationChangedNotification JSON payload.

Per Diem Shift Time Changed#

When the start or end time for a Per Diem Shift is changed, the Per Diem Shift Time Changed event will POST a PerDiemShiftTimeChangedNotification JSON payload.

Per Diem Shift Rate Changed#

When the rate type for a Per Diem Shift is changed, the Per Diem Shift Rate Changed event will POST a PerDiemShiftRateChangedNotification JSON payload.

Per Diem Shift Note Changed#

When the rate type for a Per Diem Note is changed, the Per Diem Shift Note Changed event will POST a PerDiemShiftNoteChangedNotification JSON payload.
Modified at 2025-09-24 18:46:50
Previous
Home
Next
Jobs Sync
Built with