test_result_ready

Triggered when a quality check workflow activity is completed and if the workflow has enableTestReadyWebhook enabled

For example:

{
	"activityType":"quality-checks",
	"name":"Reference Sample Review",
	"label":"reference-qpcr-qc",
	"attributes":
		{
			"enableTestReadyWebhook":true
			"status":[ ... ]
		}
}

All timestamps are in UTC.

Sample Payload

{
  "eventType": "test_result_ready",
  "organizationId": 5499,
  "workflowId": 24766,
  "workflowDefinitionId": 116366,
  "workflowName": "reference infectious disease",
  "workflowType": "reference-infectious-disease",
  "sampleTestResults": [
    {
      "sampleIdentifier": "REQ-004",
      "workflowSampleResultId": 5723139,
      "routeWorkflowTypes": [
        "reference-medication"
      ]
    }
  ]
}

Payload Description

Test Result Ready Object

Key	Type	Description
eventType	string	The action performed
organizationId	integer	ID of the organization
workflowId	integer	ID of the workflow sending the test results
workflowDefinitionId	integer	ID of the workflow definition used by workflow
workflowName	string	Name of workflow creating the test results
workflowType	string	The type of workflow
sampleTestResults	object array	Array of test results objects

Sample Test Result Object

Key	Type	Description
sampleIdentifier	string	The sample identifier
workflowSampleResultId	integer	The workflow sample result, could be used in the /v3/workflow_sample_results/{workflowSampleResultId} endpoint to get more information about the sample test results
routeWorkflowTypes	string array	Array of workflow types this sample is routed to