Snapshot Statuses

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 optional employee_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.

Member snapshots can have one of six statuses:

submittedThe member snapshot has been submitted to Noyo. We have run some initial processing and validation at this point. It will begin processing shortly.
processingWe are communicating the member changes to the carrier(s) involved.
completedThe member changes are reflected in the carrier system(s).
failedThe member snapshot failed to apply at one or more carrier(s). For this status, we will include an errors array at the top level of the API response. Each object in this array will include a message and a carrier_id, which will explain more about the relevant issue for that carrier.
canceledIf the member snapshot is not fulfillable, it will be updated to canceled before completion.
replacedIf 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.

The 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.

Checking the Employee status (optional)

As an alternative to checking the status of individual snapshots, it’s also possible to check the status of individual employees. Employees may be associated with multiple sequential snapshots, only the most recent of which can be active/uncancelled.

Poll the employee status endpoint to track when all snapshots have been processed.

This endpoint allows you to track the status of Noyo updating the carrier system with any changes found in the latest member snapshot for an employee and their family. Employees can have one of three statuses:

  • stable - The carrier system reflects the latest snapshot. No snapshot requests are outstanding.
  • pending_changes - Noyo is still working to update the carrier system. There is an outstanding snapshot request.
  • unable_to_fulfill - Noyo was previously unable to update the carrier. This status contains an error message with the reason and any next steps for you to complete.

The employee status endpoint will also return a list of carrier statuses with one entry for each carrier associated with the family. The latest_platform_change field will include a reference to the most recent completed member snapshot, if any. If the employee has a status of unable_to_fulfill, that latest platform change field will include a set of error details. If the employee has a status of pending_changes, the pending_changes list will include an entry for the member snapshot that Noyo is currently processing.

What’s Next

Learn about member transactions