Examples for Ratatoskr Delivery Metadata

From DeliveryMetadata.yaml (ratatoskr/DeliveryMetadata.schema)

---
{}
---
create_delivery: false
---
botmdhospital:
  delivery_uids:
    - xxx
  status: delivered
---
line:
  webhook_event_id: xxxxxx12345
  status: received
  received_on: "2021-04-17T03:46:09.591390881Z"
---
line:
  status: hold_until_follow
  hold_until_follow_on: "2021-04-17T03:46:09.591390881Z"
---
messagebird:
  message_id: 553c26105fd041969aff7eafacbcb2b2
  status: read
  posted_on: "2021-04-17T03:46:09.591390881Z"
  pending_on: "2021-04-17T03:46:09.591390881Z"
  transmitted_on: "2021-04-17T03:46:09.591390881Z"
  read_on: "2021-04-17T03:46:09.591390881Z"
---
messagebird:
  message_id: 553c26105fd041969aff7eafacbcb2b2
  status: received
  received_on: "2021-04-17T03:46:09.591390881Z"
---
messagebird:
  message_id: null
  status: read
  failed_on: "2021-04-17T03:46:09.591390881Z"
  posted_on: "2021-04-17T03:46:09.591390881Z"
  read_on: "2021-04-17T03:46:09.591390881Z"
---
messagebird:
  message_id: 553c26105fd041969aff7eafacbcb2b2
  status: received
  received_on: "2021-04-17T03:46:09.591390881Z"
  pricing:
    billable: true
    pricing_model: "CBP"
    category: "utility"
    window_expiry: "2021-04-17T03:46:09.591390881Z"
---
promotexter:
  transaction_ids: []
  status: posted
  posted_on: "2021-04-17T03:46:09.591390881Z"
---
promotexter:
  transaction_ids: [xxx]
  status: received
---
promotexter:
  transaction_ids: [xxx]
  status: received
  error_msg: Wrong ID
---
promotexter:
  transaction_ids: [xxx]
  status: received
  error_code: "12345"
---
promotexter:
  transaction_ids: [xxx, yyy, zzz]
  status: delivered
  posted_on: "2021-04-17T03:46:09.591390881Z"
  delivered_on: "2021-04-17T03:46:09.591390881Z"
---
pinpoint:
  status: posted
  posted_on: "2018-06-01T12:34:56+08:00"
  message_id: xxxxxxxxxx12345
---
pusher:
  status: sent
---
pusher:
  status: failed
---
pusher:
  status: sent
  truncated: true
---
pusher:
  status: read
  truncated: true
---
pusher:
  status: sent

hospital:
  delivery_by: alert

---
pusher:
  status: sent

variables:
  jwt: "012345465abcefefdfdfdfsffdsf"
  hello_00: world
  find_within_url[0]: https://botmd.com/?index=0
  find_within_url[1]: https://botmd.com/?index=1
  find_within_url[2]: https://botmd.com/?index=2
  find_within_url[string]: https://botmd.com/?index=3
  patient[underscore_inside]: Hello world

---
qiscus:
  status: sent
  posted_on: "2021-10-01T12:34:56.789Z"
  sent_on: "2021-10-01T12:34:56.789Z"
  payload_type: whatsapp
  message_ids: ["wamid.xxx1234567=="]
  pricing:
    billable: true
    pricing_model: "CBP"
    category: "utility"
---
qiscus:
  message_ids: [xxx12345]
  payload_type: multichannel
  handover: true
  status: posted
  posted_on: "2021-10-01T12:34:56.789Z"
---
qontak:
  message_ids: ["xxx12345"]
  error: Permission Denied
  status: read
---
ses:
  incoming_receipt:
    message_id: xxxxx12345xxxxx
    payload:
      mail:
        commonHeaders:
          from: ["Example User <user@example.com>"]

      receipt:
        recipients: developer@staging.botmd.io
        action:
          type: S3
          topicArn: arn:aws:sns:us-east-1:xxxxxxxxxx:xxxxx
          bucketName: temporary
          objectKeyPrefix: ratatoskr/ses/inbound/
          objectKey: ratatoskr/ses/inbound/xxxxx
#end ses

---
ses:
  outgoing_metadata:
    message_id: xxxxx12345xxxxx
    status_code: 200
---
ses:
  status: bounced
  outgoing_metadata:
    message_id: xxxxx12345xxxxx
    status_code: 200
---
smooch:
  message_id: xxx
  status: sent
---
smtp:
  status: sent
---
smtp:
  status: failed
  error: This is a post_failed error.
---
smooch:
  message_id: xxx
  status: delivery_success
  sent_on: "2020-01-01T12:33:00+00:00"
  delivery_success_on: "2020-01-01T12:33:00+00:00"
---
smooch:
  message_id: xxx
  status: delivery_failure
  sent_on: "2020-01-01T12:33:00+00:00"
  delivery_success_on: "2020-01-01T12:33:00+00:00" # doesnt make sense. but it will be far too complicated to make a schema that capture these.
  delivery_failure_on: "2020-01-01T12:35:00+00:00" # timezone required
---
telegram:
  update_id: 1234512345
  message_ids: [12345]
  status: received
---
twilio:
  delivered_on: "2021-03-29T08:45:24.735294+00:00"
  message_sid: SMA8Z1B0Qr2xdyxxxxxxxxxxxx123456
  failed_on: "2021-03-29T08:45:23.226404+00:00"
  posted_on: "2021-03-29T08:45:22+00:00"
  sent_on: "2021-03-29T08:45:23.226404+00:00"
  status: delivered
  sent_from: "+6590000001"
---
twilio:
  delivered_on: "2021-03-29T08:45:24.735294+00:00"
  message_sid: SMA8Z1B0Qr2xdyxxxxxxxxxxxx123456
  undelivered_on: "2021-03-29T08:45:23.226404+00:00"
  posted_on: "2021-03-29T08:45:22+00:00"
  sent_on: "2021-03-29T08:45:23.226404+00:00"
  status: undelivered
  sent_from: "+6590000001"
---
twilio:
  received_on: "2021-03-29T08:45:22+00:00"
  received_by: "+6590000001"
  status: received
  message_sid: SMA8Z1B0Qr2xdyxxxxxxxxxxxx123456
  billing:
    num_segments: 3
    price: "0.075"
    price_unit: USD
    updated_on: "2021-03-29T08:45:22+00:00"
---
viber:
  message_token: "4912661846655238145"
  status: seen
  posted_on: "2021-04-17T03:46:09.591390881Z"
---
whatsapp:
  received_on: "2021-03-29T08:45:22+00:00"
  status: received
  pricing:
    billable: true
    pricing_model: "CBP"
    category: "business_initiated"
  message_ids: [wamid.XXXXX==]
---
whatsapp:
  received_on: "2021-03-29T08:45:22+00:00"
  status: received
  message_ids: [wamid.XXXXX==]
  errors:
    - code: 1234
      description: this is an error
---
whatsapp:
  received_on: "2021-03-29T08:45:22+00:00"
  status: post_failed
  message_ids: []
  error: This is a post_failed error.
---
action_state:
  executed_by: xxxxx12345
---
action_state:
  is_execution_successful: true
  is_via_jwt: true
  redirect_to: https://example.com
---
action_state:
  is_execution_successful: false
  ignore_outgoing_delivery: true
---
fcm:
  mute: true
---
fcm:
  status: sent
  data_message: {}
---
fcm:
  status: failed
  data_message: {}
---
fcm:
  status: not_sent
  data_message: {}
---
fcm:
  data_message:
    type: new_message
    message: "You have a new message."
---
bifrost:
  organization: botmd
  flow_uid: xxx
  connection_uid: xxx
  purpose: messaging
---
bifrost:
  organization: botmd
  query_delivery_uid: xxxxxxxxxx1234567890123456789012
---
cleo:
  delivery_by: reminder
  clinic: example
  patient_form_uid: xxxxxpatient12345
  profile_uid: xxxxxclinician12345
  reminder_event_pk: 123
---
cleo:
  delivery_by: bot
  clinic: null # sometimes even the clinic is not known
  profile_uid: null # sorry messages dont have a profile
---
cleo:
  delivery_by: update_metadata_entry
  clinic: example
  profile_uid: xxxxxclinician12345
  patient_form_uid: xxxxxpatient12345
  clinical_parameter_uid: xxxxx12345
---
cleo:
  delivery_by: alert
  clinic: example
  profile_uid: xxxxxclinician12345
  patient_form_uid: xxxxxpatient12345
---
cleo:
  delivery_by: clinician
  clinic: example
  profile_uid: xxxxxclinician12345
  patient_form_uid: xxxxxpatient12345
---
cleo:
  delivery_by: reminder
  clinic: example
  profile_uid: xxxxxpatient12345
  patient_event_uid: xxxxxpatientevent12345
  message_template_pk: 75
---
cleo:
  delivery_by: clinician
  clinic: example
  profile_uid: xxxxxpatient12345
  patient_group_uid: xxxxxpatientgroup12345
  message_template_pk: 75
---
cleo: # Incoming
  delivery_by: user
  clinics: [example, notenrolled]
  profile_uids: [xxxxxclinician12345]
---
cleo: # Incoming but dont know for who
  delivery_by: user
  clinics: []
  profile_uids: []
---
cleo:
  delivery_by: alert
  clinic: example
  patient_form_uid: xxxxx12345
  profile_uid: xxxxx12345
---
cleo:
  delivery_by: greeting
  clinic: example
  patient_form_uid: xxxxx12345
  profile_uid: xxxxx12345
---
cleo:
  delivery_by: disclaimer
  clinic: example
  message_template_pk: 123
  profile_uid: xxxxx12345
---
cleo:
  delivery_by: scheduling_reminder
  clinic: example
  message_template_pk: 123
  profile_uid: xxxxx12345
---
cleo:
  delivery_by: clinician
  clinic: example
  profile_uid: xxxxxpatient12345
  patient_program_form_uid: xxxxxpatientprogramform12345
  message_template_pk: 75
---
cleo:
  delivery_by: clinician
  clinic: example
  profile_uid: xxxxxpatient12345
  patient_program_uid: xxxxxpatientprogram12345
  message_template_pk: 75

variables:
  alert_reasons: |-
    ES Sx (Exit Site Symptom) is Yes (Yes)
    Sx (Symptom) is Yes (Yes)
  alert_rule: NKTI PD Alert
  clinic[domain]: nktipd
  clinic[effective_logo]: https://example.s3.amazonaws.com/cleo/clinic/fXERGnDrNWF8nNzmKLpoPbFdzlm0mSB6/logo.png?hidden
  clinic[name]: Example
  clinic[uid]: clinic12345
  clinician[designation]: Medical Officer
  monitoring_form[effective_name]: Example Monitoring Form
  monitoring_form[language]: tl
  monitoring_form[uid]: monitoringform12345
  monitoring_form[url]: https://example.com/to/xxxx
  monitoring_formset[alert_rules]: Example Alert
  monitoring_formset[clinical_parameters]: ES Img, ES Sx (Exit Site Symptoms), Sx
    (Symptoms), Daily PD, Discharge Color, ES Sx (Exit Site Symptom), Sx (Symptom)
  monitoring_formset[name]: Example Monitoring Form
  monitoring_formset[uid]: monitoringformset12345
  patient[alertees]: John Smith
  patient[ics]: John Smith
  patient[identifier]: XXXXX0815
  patient[language]: en
  patient_form[alert_rules]: Example Alert
  patient_form[created_on]: "2021-12-27T06:32:32.575032+00:00"
  patient_form[deactivated_on]: "2021-12-27T06:40:07.532179+00:00"
  patient_form[reminders]: 1 - Daily 9am
  patient_form[uid]: patientform123456
  profile[name]: John Smith
  profile[phone]: "+6591231234"
  profile[uid]: xxxxx123456
  submission[created_on]: "2021-12-27T06:33:46.995334+00:00"
  submission[on]: 2021-12-27 14:33
  submission[uid]: xxxxxx123456
  submission[values]: ""
  submission_value[BqTdOeqV8krymWpeJicy7lbUoHz9lzTg]: "Yes"
  submission_value[Daily PD]: 4 Bags
  submission_value[Discharge Color]: Naninilaw
  submission_value[ES Img]: https://example.s3.amazonaws.com/onform/qa_parser/files/cleo/nktipd/O7pK9QAzlzEws8epw5hparbpu074s3KQ.jpeg?hidden
  submission_value[ES Sx (Exit Site Symptom)]: "Yes"
  submission_value[ES Sx (Exit Site Symptoms)]: Nana
  submission_value[Sx (Symptom)]: "Yes"
  submission_value[Sx (Symptoms)]: Lagnat
  submission_value[value12345]: Nana
  submission_value[value12346]: Naninilaw
  submission_value[12347]: "Yes"
  submission_value[12348]: 4 Bags
  submission_value[12349]: Lagnat
  submission_value[12340]: https://example.s3.amazonaws.com/onform/qa_parser/files/cleo/nktipd/O7pK9QAzlzEws8epw5hparbpu074s3KQ.jpeg?hidden
  submission_value[uid]: value12345666
---
cleo:
  clinic: xxxx
  delivery_by: bot
  profile_uid: null

jarvis:
  query_engine:
    name: xxx-llm-query-engine
    version: xxxxx12345
  version: xxxxxx
---
chemocalc:
  session_uid: xxxxxxxx
  delivery_by: system
  message_template_uid: xxxxx12345
---
faraday:
  profile_uid: xxxxxxxx
  delivery_by: system
  clinic: hello
  message_template_pk: 123
  order_uid: xxx123
  order_exam_uids: ["xxxx1", "xxxx2"]
---
healthcheck:
  ping_delivery_uid: xxxxx12345
---
heimdall:
  provider_application_uid: xxxxxx12345
---
hospital:
  delivery_by: bot
  response_time: 0
---
hospital:
  delivery_by: email_notification
---
hospital:
  delivery_by: profile_reminder
---
hospital:
  query_delivery_uid: xxxxxxxxxx1234567890123456789012
  response_time: 1.2323
---
hospital:
  delivery_by: ecg
---
hospital:
  delivery_by: query
---
hospital:
  delivery_by: bot
---
hospital:
  short_name: TTSH
  delivery_by: moodlog_reminder

einstein:
  broadcast_uid: xxxxxxxxxx1234567890123456789012
---
jarvis:
  query_engine:
    name: xxx-llm-query-engine
    version: kondoversion123
  version: hippoversion123
---
jarvis:
  module_response:
    type: clinical-trial-ir
    answer_count: 2
  query_engine:
    name: clinical-trial-ir
    version: 33d28e53318bcdb4efc12a3449c34bb6b007494b
  version: f23227779dfc05571b26bfdd692c2a73b5d47805
---
mastermind:
  delivery_by: jane
---
maxwell:
  order_id: 1337
---
ratatoskr:
  is_technical_error_message: true
  is_unsubscribe_message: true
  is_subscribe_message: true
---
retry_deliveries:
  delivery_by: mastermind
  delivery_uid: xxxxx12345
  retried_by: yc
  retry_attempts: 3
---
has_retried: false
---
query_metrics:
  is_sorry: false
  is_confident: true
  modules: ["chernobyl", "heisenberg", "eliza"]
  miniapps: ["calculators", "directory"]
  query: hello world
  hospital: ktph
  query_nonce: xxxxxxxxxx1234567890123456789012


[Main Page] [Schema Documentation] [Raw Schema] [JSON Schema]