Delivery.metadata is usually set by providers to track the messages being sent and received.
Whether to create delivery object during outgoing flows.
Delivery metadata for BotMDHospitalProvider.
Delivery status
Delivery UID of delivery to native app. There can be multiple delivery UIDs when the user has multiple devices.
No Additional ItemsMust be at least 1 characters long
Delivery metadata for LineProvider.
Delivery status enumerated by LineDeliveryStatus.
The webhook event ID associated with an incoming delivery.
Must be at least 1 characters long
Message IDs associated with this delivery.
Must contain a minimum of 0 items
Must be at least 1 characters long
Whether this delivery has been unsent. Defaults to false.
All properties whose name matches the following regular expression must respect the following conditions
Property name regular expression:^\w+_on$
This field is set when the status of the delivery is updated.
Delivery metadata for MessagebirdProvider; obtained from https://developers.messagebird.com/api/conversations/#messagestatus-object.
Messagebird message_id is useful for tracking the delivery status of a message.
Delivery status enumerated by MessagebirdDeliveryStatus.
Pricing information for the message.
Whether the message is billable based on conversation window.
The pricing model used for the message.
The category of the message.
When the conversation window expires
The error object within the message payload. Only set when exist.
All properties whose name matches the following regular expression must respect the following conditions
Property name regular expression:^\w+_on$
This field is set when the status of the delivery is updated.
Delivery metadata for MessengerProvider.
Payload entry ID, i.e., payload['id'].
Must be at least 1 characters long
List of message IDs, i.e., payload['messaging'][*]['mid']. Usually there is only 1.
Must be at least 1 characters long
Delivery status enumerated by MessengerDeliveryStatus.
All properties whose name matches the following regular expression must respect the following conditions
Property name regular expression:^\w+_on$
This field is set when the status of the delivery is updated.
Delivery metadata for NoopProvider and NoopPhoneProvider.
Delivery status.
Delivery metadata for NoopProvider and NoopPhoneProvider.
Delivery status.
Message ID of inbound/outbound messages.
Must be at least 1 characters long
All properties whose name matches the following regular expression must respect the following conditions
Property name regular expression:^\w+_on$
This field is set when the status of the delivery is updated.
Delivery metadata for PromoTexterProvider. See PromoTexter Messaging API for more information.
PromoTexter specific transaction IDs for each API request.
No Additional ItemsMust be at least 1 characters long
Delivery status enumerated by PromoTexterDeliveryStatus.
Error code returned by the provider.
All properties whose name matches the following regular expression must respect the following conditions
Property name regular expression:^\w+_on$
This field is set when the status of the delivery is updated.
Additional Properties of any type are allowed.
Type: objectDelivery metadata for PusherProvider.
Delivery status enumerated by PusherDeliveryStatus.
Message was not included in Pusher payload due to size restrictions.
Delivery metadata for QiscusMultichannelProvider.
Delivery status enumerated by PromoTexterDeliveryStatus.
Message ID for incoming and outgoing messages. For incoming messages, it is of the form {payload["message"]["unique_temp_id"]}:{payload["message"]["id"]}. Only messages sent via WhatsApp API have message IDs.
Must be at least 1 characters long
Whether the payload is sent or recieved via the multichannel API or WhatsApp API.
Pricing information for the message.
Whether the message is billable based on conversation window.
The pricing model used for the message.
The category of the message.
True if this is a handover delivery and the handover was done successfully. If unsuccessful, it will be false. This value is null or unspecified for regular message deliveries.
All properties whose name matches the following regular expression must respect the following conditions
Property name regular expression:^\w+_on$
This field is set when the status of the delivery is updated.
Delivery metadata for QiscusMultichannelProvider.
Message ID for incoming and outgoing messages. For incoming messages, it is of the form {payload["id"]}
Must be at least 1 characters long
True if this is a handover delivery and the handover was done successfully. If unsuccessful, it will be false. This value is null or unspecified for regular message deliveries.
Error message.
Delivery status enumerated by QontakDeliveryStatus.
All properties whose name matches the following regular expression must respect the following conditions
Property name regular expression:^\w+_on$
This field is set when the status of the delivery is updated.
Delivery metadata for SESProvider.
Delivery status enumerated by SESDeliveryStatus.
Receipt metadata. This is basically the SES notification payload.
No Additional PropertiesThe SES assigned message ID.
Must be at least 1 characters long
The original payload from SES.
This is provided by SES. See https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-notifications-examples.html
This is provided by SES. See https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-notifications-examples.html
Additional Properties of any type are allowed.
Type: objectOutgoing metadata. This is basically the SES response to send_email.
The outgoing message ID given by AWS SES.
Must be at least 1 characters long
The HTTPStatusCode returned by SES.
All properties whose name matches the following regular expression must respect the following conditions
Property name regular expression:^\w+_on$
This field is set when the status of the delivery is updated.
Delivery metadata for SmoochProvider.
Smooch message_id is useful for tracking the delivery status of a message.
Delivery status enumerated by SmoochDeliveryStatus.
An API key used by Bot MD to determine the organization using the Smooch application. This is necessary because we multiplex multiple clients into one Smooch application.
Must be at least 1 characters long
All properties whose name matches the following regular expression must respect the following conditions
Property name regular expression:^\w+_on$
This field is set when the status of the delivery is updated.
Delivery metadata for SMTPProvider.
Delivery status enumerated by SMTPDeliveryStatus.
Error message when failed to deliver email.
All properties whose name matches the following regular expression must respect the following conditions
Property name regular expression:^\w+_on$
This field is set when the status of the delivery is updated.
Delivery metadata for TelegramProvider.
The update_id in the webhook payload is globally unique. See Python Telegram Bot documentation.
Telegram message.message_ids are incremental ID that are not globally unique.
Delivery status enumerated by TelegramDeliveryStatus.
All properties whose name matches the following regular expression must respect the following conditions
Property name regular expression:^\w+_on$
This field is set when the status of the delivery is updated.
Delivery metadata for TwilioProvider. Information about message statuses can be found here https://www.twilio.com/docs/messaging/guides/webhook-request#status-callback-parameters
Twilio message_sid is useful for tracking the delivery status of a message.
Delivery status enumerated by TwilioDeliveryStatus.
This is the Twilio phone number that received the message. This is useful when multiple numbers are used for the same Twilio provider.
Must match regular expression:^\+\d{5,}$
This is the Twilio phone that sent the message. This is useful when multiple numbers are used for the same Twilio provider.
Must match regular expression:^\+\d{5,}$
Metadata related to billing.
No Additional PropertiesNumber of segments used for billing purposes.
Value must be strictly greater than 0
Price of this message as charged by Twilio. String because it is treated as a Decimal.
The currency of price.
Must be at least 1 characters long
Date/time the billing information was synced.
All properties whose name matches the following regular expression must respect the following conditions
Property name regular expression:^\w+_on$
This field is set when the status of the delivery is updated.
Delivery metadata for ViberProvider.
The message token associated with an incoming delivery.
Must be at least 1 characters long
Delivery status enumerated by ViberDeliveryStatus.
All properties whose name matches the following regular expression must respect the following conditions
Property name regular expression:^\w+_on$
This field is set when the status of the delivery is updated.
Delivery metadata for WhatsAppProvider.
List of message IDs. Usually there is only 1.
No Additional ItemsMust be at least 1 characters long
Delivery status enumerated by WhatsAppDeliveryStatus.
Pricing information for the message.
Whether the message is billable.
The pricing model used for the message.
The category of the message.
Errors received from provider's webhook
No Additional ItemsError message for post_failed.
All properties whose name matches the following regular expression must respect the following conditions
Property name regular expression:^\w+_on$
This field is set when the status of the delivery is updated.
Delivery metadata for ActionState.
If this delivery is the result of an action state execution, it will be the UID of the delivery that "triggered" the execution.
Must be at least 1 characters long
True if this action state delivery executed successfully. Only action state deliveries will have this value set.
Whether this action state's ApplicationPayload was created via JWT.
Ignore outgoing delivey for action state message
When executing in via JWT, this value holds the URL to redirect the user to. This is used internally.
Delivery metadata for FCMProvider.
When this is set to true, the delivery doesn't get through the fcm provider.
Use this to override the default data message.
Additional Properties of any type are allowed.
Type: objectStatus of FCM delivery message
Delivery metadata for Bifrost application.
Key of Bifrost organization that created this delivery.
Must be at least 1 characters long
UID of Bifrost flow that created this delivery.
Must be at least 1 characters long
UID of Bifrost connection that created this delivery.
Must be at least 1 characters long
Purpose Bifrost flow-connection that created this delivery.
Must be at least 1 characters long
The UID of the query delivery object. Useful for tracking query and responses.
Must be at least 1 characters long
Delivery metadata for Chemocalc application.
Describes the type of the message (e.g., alert, reminder, etc).
UID of the message template used for outgoing delivery.
Must be at least 1 characters long
UID of patient/doctor who sent the delivery.
Must be at least 1 characters long
Delivery metadata for Cleo application.
Describes the type of the message (e.g., alert, reminder, etc).
Clinic that this outgoing delivery is part of.
Clinics that this incoming delivery is part of.
Must contain a minimum of 0 items
Must be at least 1 characters long
UID of patient/clinician delivered to. This is for all outgoing deliveries.
UID of patient for whom the delivery was processed. This is for all incoming deliveries.
Must contain a minimum of 0 items
Must be at least 1 characters long
UID of associated patient-event's calendar. This is for outgoing deliveries related to events.
Must be at least 1 characters long
UID of associated patient-event. This is for outgoing deliveries related to events.
Must be at least 1 characters long
UID of associated patient-form. This is for outgoing deliveries related to patient-forms.
Must be at least 1 characters long
UID of associated patient group. This is for outgoing deliveries using patient groups without monitoring forms.
Must be at least 1 characters long
UID of associated patient-payment. This is for outgoing deliveries related to patient-payments.
Must be at least 1 characters long
UID of associated patient-payment transaction. This is for outgoing deliveries related to patient-payments.
Must be at least 1 characters long
UID of associated patient program. This is for outgoing deliveries using patient program.
Must be at least 1 characters long
UID of associated patient program form. This is for outgoing deliveries using patient program form.
Must be at least 1 characters long
The UID of the query delivery object. Useful for tracking query and responses.
Must be at least 1 characters long
Primary key of the message template used for outgoing delivery.
Value must be greater or equal to 1
Primary key of associated reminder event. This is for reminder deliveries.
Value must be greater or equal to 1
For messages sent by clinicians (i.e., triggered via dashboard), this field will contain the clinician's UID.
Must be at least 1 characters long
UID for clinical parameter that is being updated.
Must be at least 1 characters long
Delivery metadata associated with the specialized Engage application.
No Additional PropertiesThe module corresponding to this delivery.
Must be at least 1 characters long
The stage corresponding to this delivery.
Delivery metadata for Einstein related features.
No Additional PropertiesBroadcast UID which this delivery is sent from.
Must be at least 1 characters long
Delivery metadata for Faraday application.
Describes the type of the message (e.g., alert, reminder, etc).
Clinic that this delivery is part of.
Primary key of the message template used for outgoing delivery.
Value must be greater or equal to 1
For messages sent to patients, this field will contain the order's UIDs.
Must be at least 1 characters long
For messages sent to patients, this field will contain the orderexam's UIDs.
No Additional ItemsMust be at least 1 characters long
UID of staff/patient delivered to.
The UID of the query delivery object. Useful for tracking query and responses.
Must be at least 1 characters long
Delivery metadata for Healthcheck.
No Additional PropertiesDelivery UID for the incoming ping delivery. This is set for outgoing pong deliveries.
Must be at least 1 characters long
Delivery metadata for Heimdall.
No Additional PropertiesThe Heimdall OTP provider that created this delivery.
Must be at least 1 characters long
Delivery metadata for Hospital application.
Describes how the message was delivered.
These types are unique throughout the Bot MD ecosystem. These keys are used in the user's Profile.settings.notifications.deactivated[] to identify the notifications that they have deactivated.
Messages from Bot. This is the default is no delivery_by is specified.
"bot"
Alerts
Specific value:"alert"
Email Notification to Admin / User (eg. User License limit, activation, expiry, etc.)
Specific value:"email_notification"
Broadcast to hospital
Specific value:"broadcast"
Profile related reminder (eg. profile creation, activation, expiry, etc).
Specific value:"profile_reminder"
Temperature reminder for Singapore hospitals.
Specific value:"temperature_reminder"
ART reminder for Singapore hospitals.
Specific value:"art_reminder"
ED Roster Updates used by TTSH Emergency Department.
Specific value:"ed_roster"
Mental Health bot for TTSH.
Specific value:"emobot"
Mood Log Reminder for TTSH Mental Health Module (2024)
Specific value:"moodlog_reminder"
ECG Updates used by TTSH Emergency Department.
Specific value:"ecg"
Arise/PSP used by Roche.
Specific value:"arise_psp"
Hospital short name for the profile recieving this delivery.
The UID of the query delivery object. Useful for tracking query and responses.
Must be at least 1 characters long
Time taken to get response from athena. Includes internal service network RTT.
Value must be greater or equal to 0
Delivery metadata for Jarvis application.
Name of the query engine as specified in the query engine settings.
Must be at least 1 characters long
Version of the query engine. This is based on the Kondo version (i.e., commit ID of the corresponding Kondo resource).
Additional Properties of any type are allowed.
Type: objectVersion of Jarvis. This is usually equivalent to the deploy Hippocrates version.
Must be at least 1 characters long
Summary of the module that responded to this query.
Type/Name of the module that responded to this query.
Must be at least 1 characters long
Additional Properties of any type are allowed.
Type: objectDelivery metadata for when a delivery is sent by a Mastermind user from the device page.
No Additional PropertiesThe Mastermind user that sent this delivery.
Delivery metadata for maxwell orders.
No Additional PropertiesMaxwell Order ID associated with this message delivery.
Delivery metadata related to Ratatoskr.
No Additional PropertiesThis delivery is in response to an unhandled exception.
This delivery is in response to an subscribe request.
This delivery is in response to an unsubscribe request.
Delivery metadata for when a delivery is retried using the retry_deliveries management command.
How retry delivery was invoked.
The uid of the delivery that is being retried.
Must be at least 1 characters long
Either the AWS STS caller ID or Mastermind username of the user who triggered the retry.
Must be at least 1 characters long
Number of times the delivery has been retried.
Whether the delivery has been retried to sent so it won't auto-retry again.
Used for variable substitution inside message content. Any instance of ${name} in the message content will be replaced using simple string substitution.
Each additional property must conform to the following schema
Type: stringContains information related to the Jarvis query flow for use in analysis.
Must be at least 1 characters long
Must be at least 1 characters long
Must be at least 1 characters long
Must be at least 1 characters long
Delivery metadata for legacy ChatResponses.
Additional Properties of any type are allowed.
Type: object