- Most general: Snapshot Status
- Per-carrier validation and fulfillment: Snapshot Fulfillment Summary
- Field-level tracking and diffing for enrollment changes: Tracking API
Snapshot Status
As Noyo processes the requested changes, you can periodically poll for status by sending a call to get a single snapshot. This endpoint returns a copy of one member snapshot, including the current status and the full contents of what was submitted. You can also get data about all snapshots for a given group with the group snapshots endpoint. This endpoint returns a paginated list of snapshot records associated with employees in a group. Each result in the list contains metadata about the snapshot request, including the unique ID and the associated employee ID, but not the complete snapshot payload. Results will default to descending order by date created, so the most recently created snapshots will be in the first page of results. This endpoint also supports an optionalemployee_id
query param to filter all snapshots for a specific employee.
When Noyo has finished making all requested changes at the carrier, the status of the member snapshot will change to completed
. For changes going to Send carriers, the status will be completed
once the file has been sent. If a member snapshot contains changes for both Sync and Send carriers, the Sync transactions will be completed first but the snapshot will only move to completed
when the file has been sent.
Member snapshots can have one of five statuses:
Status | Description |
---|---|
submitted | The member snapshot has been submitted to Noyo and we have run initial processing and validation. |
processing | We are identifying transactions and queuing them up to send to the right carrier(s) or there are still transactions contained in this snapshot that are being processed by the carrier(s). |
completed | All member transactions have been completed by the Sync carrier or the file has been sent to the Send carrier. |
canceled | The request was canceled and no changes have been sent to the carrier. |
replaced | If the member snapshot was overridden by a subsequent snapshot while in the processing status, we will update the status to replaced and no longer attempt to fulfill this snapshot. |
replaced
status applies to snapshots which were in progress, but were not completed before a new snapshot was received for the same employee. Noyo will only try to process and confirm the latest snapshot received, on the assumption that the latest snapshot contains the most up-to-date information.
When the snapshot status is completed
, Noyo schedules the second of our round-trip confirmation checks, which queries the carrier’s system on the change’s effective date to ensure that it still happens as expected.
Snapshot Fulfillment Summary
Many snapshots have information and enrollments that span multiple carriers. Whenever possible, Noyo does not block well-formed snapshots from processing at Carrier A if there are issues with the input(s) for Carrier B. These mechanics ensure a fast, accurate fulfillment process but introduce nuance in the idea of a snapshot’s “status.” Here are two examples of scenarios where the overall snapshot status may not be particularly useful:- There are blocking issues for one carrier but not another The provided body has validation issues that only affect one of the carriers but don’t affect another (e.g. omitted enrollments)
- One or more carriers are Send For example, a snapshot’s updates have been sent to three carriers but the fourth is a Send carrier, meaning the update is scheduled for the future but not yet sent
sent
, invalid
or replaced
.
Because Snapshot Fulfillment Summary includes one object per carrier, it won’t include any field-level granularity or discrepancy information. It also won’t update with the results of round-trip confirmation. For that level of detail, use the Tracking API.
Fulfillment Summary Status | Description |
---|---|
processing | We are identifying changes and queuing them up to send to the right carrier(s). |
sent | All changes for a given carrier have been sent successfully. |
invalid | We have identified an issue with the snapshot data and were unable to transmit changes to a carrier. Some errors will be detected immediately (such as formatting and missing data errors) while others will begin in processing and move toinvalid when the error is detected. |
scheduled | All changes that must be included on a scheduled transmissions are queued and ready. |
no_changes | No changes identified from the snapshot for the carrier. |
replaced | Processing changes have been overridden by a subsequent snapshot. |