Triggered when the a report is created with a status of "sent-for-generation"

All timestamps will be in UTC

Sample Payload

  "eventType": "report_ready_for_generation",
  "reportId": 1,
  "projectTemplateId": 1,
  "workflowId": 1,
  "workflowDefinitionId": 1,
  "workflowName": "",
  "overallStatus": "processing",
  "requisitionIdentifier": "",
  "requisitionCustomAttributes": {},
  "sampleIdentifier": "",
  "sampleCollectionDate": "2020-05-05T14:10:00.000Z",
  "sampleReceivedDate": "2020-10-10T09:02:00.000Z",
  "sampleLabel": "",
  "sampleStatus": "",
  "sampleCustomAttributes": {},
  "patientIdentifier": "",
  "patientMRN": "",
  "patientFirstName": "",
  "patientMiddleName": "",
  "patientLastName": "",
  "patientDateOfBirth": "1980-01-01",
  "patientAddressLine1": "",
  "patientAddressLine2": "",
  "patientCity": "",
  "patientState": "",
  "patientPostalCode": "",
  "patientPhoneNumber": "",
  "patientRace": "",
  "patientEthnicity": "",
  "patientGender": "",
  "patientCustomAttributes": {},
  "providerAccountName": "",
  "providerAccountNumber": "",
  "providerAccountStreetAddress": "",
  "providerAccountStreetAddressLine2": "",
  "providerAccountStreetAddressCity": "",
  "providerAccountStreetAddressState": "",
  "providerAccountStreetAddressPostalCode": "",
  "providerAccountStreetAddressCountry": "",
  "providerAccountPhoneNumber": "",
  "providerNPI": "",
  "providerFirstName": "",
  "providerLastName": "",
  "testPanels": [],
  "medications": [],
  "diagnosis": [],
  "results": {
    "assay": {
      "Well Position": "A01",
      "Sample Name": "",
      "CT": "1",
      "result": "",
      "result_reason": "",
      "reviewed": false,
      "__hidden__": false
  "timestamp": 1647886336,
  "organizationTimezone": "America/Los_Angeles"

Payload description

Key Type Description
eventType string The action performed
reportId integer ID of the report created
projectTemplateId integer ID of the project template
workflowId integer ID of the workflow report generated from
workflowDefinitionId integer ID of the workflow definition used by workflow
workflowName string Name of workflow report generated from
overallStatus string Overall status of the requisition
requisitionIdentifier string Requisition Identifier
requisitionCustomAttributes object Key value pairs for all custom attributes associated with the requisition
sampleIdentifier string Sample Identifier
sampleCollectionDate string DateTime sample was collected in UTC 
sampleReceivedDate string DateTime sample was received in UTC 
sampleLabel string Sample label
sampleStatus string Sample status
sampleCustomAttributes object Key value pairs for all custom attributes associated with the sample
patientIdentifier string Patient Identifier
patientMRN string Patient MRN
patientFirstName string Patient first name
patientMiddleName string Patient middle name
patientLastName string Patient last name
patientDateOfBirth string Patient DOB
patientAddressLine1 string Patient address line 1 (street address)
patientAddressLine2 string Patient address line 2 (suite/apartment #)
patientCity string Patient city
patientState string Patient state
patientPostalCode string Patient postal code
patientPhoneNumber string Patient phone number
patientRace string Patient race
  • White
  • Asian
  • American Indian / Alaska Native
  • Black / African American
  • Native Hawaiian / Pacific Islander
  • Undisclosed
patientEthnicity string Patient ethnicity
  • Hispanic or Latino
  • Not Hispanic or Latino
  • Undisclosed
patientGender string Patient gender
  • male
  • female
  • undisclosed
patientCustomAttributes object Key value pairs for all custom attributes associated with the patient
providerAccountName string Provider account name
providerAccountNumber string Provider account number
providerAccountStreetAddress string Provider account street address line 1 (street address)
providerAccountStreetAddressLine2 string Provider account  street address line 2 (suite/apartment #)
providerAccountStreetAddressCity string Provider account city
providerAccountStreetAddressState string Provider account state
providerAccountStreetAddressPostalCode string Provider account postal code
providerAccountStreetAddressCountry string Provider account country
providerAccountPhoneNumber string Provider account phone number
providerNPI string Provider NPI
providerFirstName string Provider first name
providerLastName string Provider last name
testPanels array Array of panel names tested for the requisition
ex: ["Covid-19","PGx"]
medications array Array of medication names entered in the Req Form
diagnosis array Array of diagnosis codes entered in the Req Form
ex: [ "Z94.0"]
results object Results object will contain JSON structured data from all results for sample.
It will include results from workflow webhook is triggered from.
If it's not triggered from a workflow is will include all workflow results for the sample. 
Will output JSON object for each assay with the key for that object being the assay code.
Data nested within each assay code key object is not standardized and will be what's configured
for the workflow.
timestamp integer Epoch timestamp of when payload was generated
organizationTimezone string Timezone configured for organization. All time stamps in payload will be sent in UTC
ex: "America/Los_Angeles"
Did this answer your question? Thanks for the feedback There was a problem submitting your feedback. Please try again later.