ProviderApplication.application_settings are used by ratatoskr.applications.AbstractApplicationss. This field is not exposed to frontend. This is where we store secret credentials.
Application settings relating to action states.
No Additional PropertiesWhether to execute the action state automatically and bypass the original delivery handling for the application. Defaults to the application class variable action_state_execute_automatically (which is set to true).
Application settings for chatterbox applications. This is used to configure Chatterbox specific settings such as restricted organizations.
No Additional PropertiesThis user info will be augmented with user id, device id, chatroom id, and sent to Chatterbox as part of the user_info object.
Additional Properties of any type are allowed.
Type: objectThis profile input will be used for Jarvis. This should usually be overwritten with the appropriate information. Currently, only hospital application is supported.
Additional Properties of any type are allowed.
Type: objectApplication settings for jarvis applications. This is used to configure Jarvis specific settings such as query engine URI.
No Additional PropertiesThis is the URI to the jarvis query engine settings.
Must be at least 1 characters long
Settings for the LLM model during query flow.
Context size aka context length
Template for the context
Name of AWS guardrail if applicable. Should start with arn:aws:bedrock:us-west-2:.
AWS Guardrail version (string) if applicable
Max tokens returned by LLM
Name of LLM as per HuggingFace
Must be at least 1 characters long
Similarity score cutoff for node postprocessing based on reranker score
Similarity score cutoff for node postprocessing based on embedding score
Number of nodes to return after retrieval
Restricts bot to only answer only these languages. Provide list of 2-letter language codes, and double-check that Amazon Comprehend / Translate supports them.
No Additional ItemsPrompt for the LLM
Temperature
The FormSG OTP application sets a cache value with OTP from FormSG emails.
No Additional PropertiesSet the OTP value in the following cache key. Use {email} to substitute with the FormSG admin email address which is inferred from the email To header. Defaults to formsg:{email}:otp.
Must be at least 1 characters long
The Healthcheck application manages ping and pong deliveries between different providers to make sure they are working.
For HealthcheckApplication which drives the healthcheck process by regularly sending out pings (i.e., aka the pinger), we will send out ping messages to all the provider_applications defined here.
Likewise, when the pinger receives a pong message from a matching device/message, we will update the heartbeat on BetterUptime.
For provider-applications being "healthchecked" (i.e., aka the ponger), we will respond with the defined pong message if any of the provider_applications matches the device and messages on the incoming delivery.
An array of provider-applications that we will be healthchecking.
Must contain a minimum of 1 items
The device UID when sending out a ping or receiving a pong for healthcheck. We note that the device UID duplicates the provider-application name but the name is intended for readability purposes.
Must be at least 1 characters long
If set, it will report heartbeat to our Better Uptime account when a pong message is received. This is only applicable to the pinger provider-application.
Must be at least 1 characters long
Messages to send out for healthcheck pings (i.e., the pinger) and for comparison when receiving a ping (i.e., the ponger). Defaults to Message(Text('Healthcheck ping!')).
No message will be sent.
Simple text message to send.
Must be at least 1 characters long
A text message will be uniformly selected from this array.
Must contain a minimum of 1 items
Must be at least 1 characters long
Ratatoskr Message.schema that will be sent to the user.
No Additional PropertiesThe type of this element.
Specific value:"message"
Message element metadata.
Title primitive element.
No Additional PropertiesThe type of this element.
Specific value:"title"
Title content.
Must be at least 1 characters long
Subtitle primitive element.
No Additional PropertiesThe type of this element.
Specific value:"subtitle"
Subtitle content.
Must be at least 1 characters long
Text primitive element.
No Additional PropertiesThe type of this element.
Specific value:"text"
Text content.
Must be at least 1 characters long
Image primitive element.
No Additional PropertiesThe type of this element.
Specific value:"image"
Image element metadata.
URL to the image file.
Overrides frontend's default image scaling algorithm.
Action to take when clicking on the image (or preview image). Defaults to opening the image in viewer.
URL to the link file. Could be application internal links too. Currently supported internal links are: botmd://hospital/postMessage, botmd://hospital/emobot, botmd://hospital/gql, and `botmd://hospital/jarvisQuery.
Must be at least 1 characters long
Whether to open the url in an external browser instead of our own webview. Defaults to false.
The MIME type of the content at URL. This is guessed from the extension of the url. If it is a http/https URL and there are no file extensions, text/html is assumed.
This is useful to override the default app responsible for opening it.
See scalpel.messages.url.ContentTypeMixin for content type guessing logic.
Must be at least 1 characters long
Metadata to describe an event that can be posted to Shadowfax. This is usually part of an Actionable.
Event type that will be posted to Shadowfax (i.e., event_type) when this action is taken.
Must be at least 1 characters long
Optional event properties that will be posted to Shadowfax (i.e., event_properties) when this action is taken.
Additional Properties of any type are allowed.
Type: objectAdditional Properties of any type are allowed.
Type: objectAdditional Properties of any type are allowed.
Type: objectAudio primitive element.
No Additional PropertiesThe type of this element.
Specific value:"audio"
Audio element metadata.
URL to the audio file.
Preview image of audio. Defaults to a generic audio icon.
URL to the image file.
Overrides frontend's default image scaling algorithm.
Action to take when clicking on the image (or preview image). Defaults to opening the image in viewer.
URL to the link file. Could be application internal links too. Currently supported internal links are: botmd://hospital/postMessage, botmd://hospital/emobot, botmd://hospital/gql, and `botmd://hospital/jarvisQuery.
Must be at least 1 characters long
Whether to open the url in an external browser instead of our own webview. Defaults to false.
The MIME type of the content at URL. This is guessed from the extension of the url. If it is a http/https URL and there are no file extensions, text/html is assumed.
This is useful to override the default app responsible for opening it.
See scalpel.messages.url.ContentTypeMixin for content type guessing logic.
Must be at least 1 characters long
Metadata to describe an event that can be posted to Shadowfax. This is usually part of an Actionable.
Event type that will be posted to Shadowfax (i.e., event_type) when this action is taken.
Must be at least 1 characters long
Optional event properties that will be posted to Shadowfax (i.e., event_properties) when this action is taken.
Additional Properties of any type are allowed.
Type: objectAdditional Properties of any type are allowed.
Type: objectAdditional Properties of any type are allowed.
Type: objectAdditional Properties of any type are allowed.
Type: objectVideo primitive element.
No Additional PropertiesThe type of this element.
Specific value:"video"
Video element metadata.
URL to the video file.
Preview image of video. Defaults to first frame of video.
URL to the image file.
Overrides frontend's default image scaling algorithm.
Action to take when clicking on the image (or preview image). Defaults to opening the image in viewer.
URL to the link file. Could be application internal links too. Currently supported internal links are: botmd://hospital/postMessage, botmd://hospital/emobot, botmd://hospital/gql, and `botmd://hospital/jarvisQuery.
Must be at least 1 characters long
Whether to open the url in an external browser instead of our own webview. Defaults to false.
The MIME type of the content at URL. This is guessed from the extension of the url. If it is a http/https URL and there are no file extensions, text/html is assumed.
This is useful to override the default app responsible for opening it.
See scalpel.messages.url.ContentTypeMixin for content type guessing logic.
Must be at least 1 characters long
Metadata to describe an event that can be posted to Shadowfax. This is usually part of an Actionable.
Event type that will be posted to Shadowfax (i.e., event_type) when this action is taken.
Must be at least 1 characters long
Optional event properties that will be posted to Shadowfax (i.e., event_properties) when this action is taken.
Additional Properties of any type are allowed.
Type: objectAdditional Properties of any type are allowed.
Type: objectAdditional Properties of any type are allowed.
Type: objectWhether to auto play video in preview view. Defaults to false.
Additional Properties of any type are allowed.
Type: objectAttachment primitive element.
No Additional PropertiesThe type of this element.
Specific value:"attachment"
Attachment element metadata.
No Additional PropertiesURL to the attachment file.
Must match regular expression:^((https|s3|gs|file)\:\/\/|\$)
Filename for attachment. This is useful when the filename cannot be inferred from the URL.
Must be at least 1 characters long
The MIME type of the attachment. This is guessed from the extension of the filename followed by the url. See scalpel.messages.url.ContentTypeMixin for content type guessing logic.
Must be at least 1 characters long
Preview image of attachment. Defaults to first frame of attachment.
URL to the image file.
Overrides frontend's default image scaling algorithm.
Action to take when clicking on the image (or preview image). Defaults to opening the image in viewer.
URL to the link file. Could be application internal links too. Currently supported internal links are: botmd://hospital/postMessage, botmd://hospital/emobot, botmd://hospital/gql, and `botmd://hospital/jarvisQuery.
Must be at least 1 characters long
Whether to open the url in an external browser instead of our own webview. Defaults to false.
The MIME type of the content at URL. This is guessed from the extension of the url. If it is a http/https URL and there are no file extensions, text/html is assumed.
This is useful to override the default app responsible for opening it.
See scalpel.messages.url.ContentTypeMixin for content type guessing logic.
Must be at least 1 characters long
Metadata to describe an event that can be posted to Shadowfax. This is usually part of an Actionable.
Event type that will be posted to Shadowfax (i.e., event_type) when this action is taken.
Must be at least 1 characters long
Optional event properties that will be posted to Shadowfax (i.e., event_properties) when this action is taken.
Additional Properties of any type are allowed.
Type: objectAdditional Properties of any type are allowed.
Type: objectAdditional Properties of any type are allowed.
Type: objectEinstein-specific metadata for this attachment
Einstein Document UID for attachment.
Must be at least 1 characters long
Button action primitive element.
No Additional PropertiesThe type of this element.
Specific value:"button"
Quick reply primitive element.
No Additional PropertiesThe type of this element.
Specific value:"quick_reply"
Quick reply element metadata.
Metadata to describe the visual aspect of a quick reply.
Display text.
Must be at least 1 characters long
Additional Properties of any type are allowed.
Type: objectMetadata to describe actions that are taken when a UI element is triggered (e.g., tapped, clicked, etc).
Same definition as actionableLocation request primitive element.
No Additional PropertiesThe type of this element.
Specific value:"location_request"
Location request element metadata.
No Additional PropertiesPrompt for the user when requesting for location.
Must be at least 1 characters long
Location request primitive element.
No Additional PropertiesThe type of this element.
Specific value:"location_response"
Location response element metadata.
No Additional PropertiesLocation latitude.
Location longitude.
Name of the location.
Must be at least 1 characters long
Human-readable address of the location.
Must be at least 1 characters long
Container types wrap around other primitive types.
Quick replies container element.
No Additional PropertiesThe type of this element.
Specific value:"quick_replies"
Array of quick replys.
Must contain a minimum of 1 items
Must contain a maximum of 16 items
Sections are container types for up to at most 3 elements. These are most likely to be used for rich messages that include media, paragraphs, and actions.
No Additional PropertiesThe type of this element.
Specific value:"sections"
An array of section elements.
Must contain a minimum of 1 items
Must contain a maximum of 5 items
Paragraphs container element.
No Additional PropertiesThe type of this element.
Specific value:"paragraphs"
An array of paragraph elements.
Must contain a minimum of 1 items
Must contain a maximum of 3 items
When specified, the message / carousel item can be favorited on the frontend.
No Additional PropertiesTitle to show in the favorites menu.
Must be at least 1 characters long
URL to favorite item. This could be an internal botmd:// link or an external link.
Must be at least 1 characters long
This is used with botmd://hospital/jarvisQuery links using uids. If frontend decides to cache the content of this favorite message, it should be refreshed against the backend after the expiry.
Actions container element.
No Additional PropertiesThe type of this element.
Specific value:"actions"
An array of action elements.
Must contain a minimum of 1 items
Must contain a maximum of 8 items
When specified, the message / carousel item can be favorited on the frontend.
Same definition as favoriteWhen specified, the message / carousel item can be favorited on the frontend.
Same definition as favoriteCarousel container element.
No Additional PropertiesThe type of this element.
Specific value:"carousel"
Carousel element metadata.
Must contain a minimum of 1 items
Must contain a maximum of 10 items
Container types wrap around other primitive types. These types are used in carousels.
Sections are container types for up to at most 3 elements. These are most likely to be used for rich messages that include media, paragraphs, and actions.
Same definition as SectionsApplication payload message.
No Additional PropertiesThe type of this element.
Specific value:"application_payload"
Application payload element metadata.
No Additional PropertiesApplication origin of the data payload
Must be at least 1 characters long
Arbitrary payload to be used by application. Can be any JSON object.
Additional Properties of any type are allowed.
Type: objectThis is a high level representation of MIME emails.
No Additional PropertiesThe type of this element.
Specific value:"email"
Email element metadata.
A short string identifying the topic of the message (RFC 2822).
Must be at least 1 characters long
The main body of the email in plain text.
The main body of the email in HTML.
Must be at least 1 characters long
Attachments to the email.
Must contain a minimum of 1 items
A message type encapsulating the WhatsApp template syntax. It is currently used by MessageBird.
No Additional PropertiesThe type of this element.
Specific value:"whatsapp_template"
WhatsApp template element metadata.
No Additional PropertiesWhatsApp template name to use for this message.
Must be at least 1 characters long
WhatsApp namespace associated with the WABA. Defaults to the provider settings namespace.
Must be at least 1 characters long
For non-WhatsApp capable providers, it will be sent as a text message containing this string.
Must be at least 1 characters long
Language code of the template. Note that language policy of the template message will always be deterministic. Defaults to en.
Must be at least 1 characters long
Array of parameters in header component of the template message. Applies to media templates only.
No Additional ItemsType of header
Image header.
URL to the image.
Must match regular expression:^((https|s3|gs)\:\/\/|\$)
Video header.
URL to the videos.
Must match regular expression:^((https|s3|gs)\:\/\/|\$)
Document attachment in media template.
URL to the document.
Must match regular expression:^((https|s3|gs)\:\/\/|\$)
Caption to accompany the document attachment.
Must be at least 1 characters long
Filename of document attachment. If caption is not specified, filename will be used instead.
Must be at least 1 characters long
Array of parameters in body component of the template message. Applies to both text and media templates.
No Additional ItemsType of body.
Text to use in body parameter.
Text to use in body parameter.
An empty message with no content whatsoever.
No Additional PropertiesThe type of this element.
Specific value:"empty"
When specified, the message / carousel item can be favorited on the frontend.
Same definition as favoriteMessage.provider_metadata is used on Messages to provide additional context to the provider for delivery.
Delivery metadata for MessengerProvider.
Use MESSAGE_TAG when sending this message. This is useful when sending messages outside of the 24 hour window. Do make sure that the tag corresponds to the actual content of the message. See Message Tags documentation for more details on what content is allowed by each tag.
This is the schema for the ReplyTo metadata representing replyee message information
No Additional PropertiesThe UID of the replyee delivery object. Used when replyee edits/deletes their message.
Replied On datetime to track when we "copied" the replyee message (may be used to check if original message was edited post-reply)
This is the schema for messages as described and proposed in the Ratatoskr: Data Models for Messages RFC.
Same definition as MessageSeries of Ratatoskr Message.schemas will be sent to the user.
Must contain a minimum of 1 items
This is the schema for messages as described and proposed in the Ratatoskr: Data Models for Messages RFC.
Same definition as MessageChoose from one of the arrays of Ratatoskr Message.schemas randomly.
No Additional PropertiesArray of choices of messages to choose from.
Must contain a minimum of 1 items
An array of messages that form this random message choice.
Must contain a minimum of 1 items
This is the schema for messages as described and proposed in the Ratatoskr: Data Models for Messages RFC.
Same definition as MessageThe relative weight of this message used to perform weighted choice. Defaults to 1.
Value must be strictly greater than 0
Messages to send out for healthcheck pongs (i.e., the ponger) and for comparison when receiving a pong (i.e., the pinger). Defaults to Message(Text('Healthcheck pong!')).
No message will be sent.
Simple text message to send.
Must be at least 1 characters long
A text message will be uniformly selected from this array.
Must contain a minimum of 1 items
Must be at least 1 characters long
Ratatoskr Message.schema that will be sent to the user.
No Additional PropertiesThe type of this element.
Specific value:"message"
Message element metadata.
Title primitive element.
No Additional PropertiesThe type of this element.
Specific value:"title"
Title content.
Must be at least 1 characters long
Subtitle primitive element.
No Additional PropertiesThe type of this element.
Specific value:"subtitle"
Subtitle content.
Must be at least 1 characters long
Text primitive element.
No Additional PropertiesThe type of this element.
Specific value:"text"
Text content.
Must be at least 1 characters long
Image primitive element.
No Additional PropertiesThe type of this element.
Specific value:"image"
Image element metadata.
URL to the image file.
Overrides frontend's default image scaling algorithm.
Action to take when clicking on the image (or preview image). Defaults to opening the image in viewer.
URL to the link file. Could be application internal links too. Currently supported internal links are: botmd://hospital/postMessage, botmd://hospital/emobot, botmd://hospital/gql, and `botmd://hospital/jarvisQuery.
Must be at least 1 characters long
Whether to open the url in an external browser instead of our own webview. Defaults to false.
The MIME type of the content at URL. This is guessed from the extension of the url. If it is a http/https URL and there are no file extensions, text/html is assumed.
This is useful to override the default app responsible for opening it.
See scalpel.messages.url.ContentTypeMixin for content type guessing logic.
Must be at least 1 characters long
Metadata to describe an event that can be posted to Shadowfax. This is usually part of an Actionable.
Event type that will be posted to Shadowfax (i.e., event_type) when this action is taken.
Must be at least 1 characters long
Optional event properties that will be posted to Shadowfax (i.e., event_properties) when this action is taken.
Additional Properties of any type are allowed.
Type: objectAdditional Properties of any type are allowed.
Type: objectAdditional Properties of any type are allowed.
Type: objectAudio primitive element.
No Additional PropertiesThe type of this element.
Specific value:"audio"
Audio element metadata.
URL to the audio file.
Preview image of audio. Defaults to a generic audio icon.
URL to the image file.
Overrides frontend's default image scaling algorithm.
Action to take when clicking on the image (or preview image). Defaults to opening the image in viewer.
URL to the link file. Could be application internal links too. Currently supported internal links are: botmd://hospital/postMessage, botmd://hospital/emobot, botmd://hospital/gql, and `botmd://hospital/jarvisQuery.
Must be at least 1 characters long
Whether to open the url in an external browser instead of our own webview. Defaults to false.
The MIME type of the content at URL. This is guessed from the extension of the url. If it is a http/https URL and there are no file extensions, text/html is assumed.
This is useful to override the default app responsible for opening it.
See scalpel.messages.url.ContentTypeMixin for content type guessing logic.
Must be at least 1 characters long
Metadata to describe an event that can be posted to Shadowfax. This is usually part of an Actionable.
Event type that will be posted to Shadowfax (i.e., event_type) when this action is taken.
Must be at least 1 characters long
Optional event properties that will be posted to Shadowfax (i.e., event_properties) when this action is taken.
Additional Properties of any type are allowed.
Type: objectAdditional Properties of any type are allowed.
Type: objectAdditional Properties of any type are allowed.
Type: objectAdditional Properties of any type are allowed.
Type: objectVideo primitive element.
No Additional PropertiesThe type of this element.
Specific value:"video"
Video element metadata.
URL to the video file.
Preview image of video. Defaults to first frame of video.
URL to the image file.
Overrides frontend's default image scaling algorithm.
Action to take when clicking on the image (or preview image). Defaults to opening the image in viewer.
URL to the link file. Could be application internal links too. Currently supported internal links are: botmd://hospital/postMessage, botmd://hospital/emobot, botmd://hospital/gql, and `botmd://hospital/jarvisQuery.
Must be at least 1 characters long
Whether to open the url in an external browser instead of our own webview. Defaults to false.
The MIME type of the content at URL. This is guessed from the extension of the url. If it is a http/https URL and there are no file extensions, text/html is assumed.
This is useful to override the default app responsible for opening it.
See scalpel.messages.url.ContentTypeMixin for content type guessing logic.
Must be at least 1 characters long
Metadata to describe an event that can be posted to Shadowfax. This is usually part of an Actionable.
Event type that will be posted to Shadowfax (i.e., event_type) when this action is taken.
Must be at least 1 characters long
Optional event properties that will be posted to Shadowfax (i.e., event_properties) when this action is taken.
Additional Properties of any type are allowed.
Type: objectAdditional Properties of any type are allowed.
Type: objectAdditional Properties of any type are allowed.
Type: objectWhether to auto play video in preview view. Defaults to false.
Additional Properties of any type are allowed.
Type: objectAttachment primitive element.
No Additional PropertiesThe type of this element.
Specific value:"attachment"
Attachment element metadata.
No Additional PropertiesURL to the attachment file.
Must match regular expression:^((https|s3|gs|file)\:\/\/|\$)
Filename for attachment. This is useful when the filename cannot be inferred from the URL.
Must be at least 1 characters long
The MIME type of the attachment. This is guessed from the extension of the filename followed by the url. See scalpel.messages.url.ContentTypeMixin for content type guessing logic.
Must be at least 1 characters long
Preview image of attachment. Defaults to first frame of attachment.
URL to the image file.
Overrides frontend's default image scaling algorithm.
Action to take when clicking on the image (or preview image). Defaults to opening the image in viewer.
URL to the link file. Could be application internal links too. Currently supported internal links are: botmd://hospital/postMessage, botmd://hospital/emobot, botmd://hospital/gql, and `botmd://hospital/jarvisQuery.
Must be at least 1 characters long
Whether to open the url in an external browser instead of our own webview. Defaults to false.
The MIME type of the content at URL. This is guessed from the extension of the url. If it is a http/https URL and there are no file extensions, text/html is assumed.
This is useful to override the default app responsible for opening it.
See scalpel.messages.url.ContentTypeMixin for content type guessing logic.
Must be at least 1 characters long
Metadata to describe an event that can be posted to Shadowfax. This is usually part of an Actionable.
Event type that will be posted to Shadowfax (i.e., event_type) when this action is taken.
Must be at least 1 characters long
Optional event properties that will be posted to Shadowfax (i.e., event_properties) when this action is taken.
Additional Properties of any type are allowed.
Type: objectAdditional Properties of any type are allowed.
Type: objectAdditional Properties of any type are allowed.
Type: objectEinstein-specific metadata for this attachment
Einstein Document UID for attachment.
Must be at least 1 characters long
Button action primitive element.
No Additional PropertiesThe type of this element.
Specific value:"button"
Quick reply primitive element.
No Additional PropertiesThe type of this element.
Specific value:"quick_reply"
Quick reply element metadata.
Metadata to describe the visual aspect of a quick reply.
Display text.
Must be at least 1 characters long
Additional Properties of any type are allowed.
Type: objectMetadata to describe actions that are taken when a UI element is triggered (e.g., tapped, clicked, etc).
Same definition as actionableLocation request primitive element.
No Additional PropertiesThe type of this element.
Specific value:"location_request"
Location request element metadata.
No Additional PropertiesPrompt for the user when requesting for location.
Must be at least 1 characters long
Location request primitive element.
No Additional PropertiesThe type of this element.
Specific value:"location_response"
Location response element metadata.
No Additional PropertiesLocation latitude.
Location longitude.
Name of the location.
Must be at least 1 characters long
Human-readable address of the location.
Must be at least 1 characters long
Container types wrap around other primitive types.
Quick replies container element.
No Additional PropertiesThe type of this element.
Specific value:"quick_replies"
Array of quick replys.
Must contain a minimum of 1 items
Must contain a maximum of 16 items
Sections are container types for up to at most 3 elements. These are most likely to be used for rich messages that include media, paragraphs, and actions.
No Additional PropertiesThe type of this element.
Specific value:"sections"
An array of section elements.
Must contain a minimum of 1 items
Must contain a maximum of 5 items
Paragraphs container element.
No Additional PropertiesThe type of this element.
Specific value:"paragraphs"
An array of paragraph elements.
Must contain a minimum of 1 items
Must contain a maximum of 3 items
When specified, the message / carousel item can be favorited on the frontend.
No Additional PropertiesTitle to show in the favorites menu.
Must be at least 1 characters long
URL to favorite item. This could be an internal botmd:// link or an external link.
Must be at least 1 characters long
This is used with botmd://hospital/jarvisQuery links using uids. If frontend decides to cache the content of this favorite message, it should be refreshed against the backend after the expiry.
Actions container element.
No Additional PropertiesThe type of this element.
Specific value:"actions"
An array of action elements.
Must contain a minimum of 1 items
Must contain a maximum of 8 items
When specified, the message / carousel item can be favorited on the frontend.
Same definition as favoriteWhen specified, the message / carousel item can be favorited on the frontend.
Same definition as favoriteCarousel container element.
No Additional PropertiesThe type of this element.
Specific value:"carousel"
Carousel element metadata.
Must contain a minimum of 1 items
Must contain a maximum of 10 items
Container types wrap around other primitive types. These types are used in carousels.
Sections are container types for up to at most 3 elements. These are most likely to be used for rich messages that include media, paragraphs, and actions.
Same definition as SectionsApplication payload message.
No Additional PropertiesThe type of this element.
Specific value:"application_payload"
Application payload element metadata.
No Additional PropertiesApplication origin of the data payload
Must be at least 1 characters long
Arbitrary payload to be used by application. Can be any JSON object.
Additional Properties of any type are allowed.
Type: objectThis is a high level representation of MIME emails.
No Additional PropertiesThe type of this element.
Specific value:"email"
Email element metadata.
A short string identifying the topic of the message (RFC 2822).
Must be at least 1 characters long
The main body of the email in plain text.
The main body of the email in HTML.
Must be at least 1 characters long
Attachments to the email.
Must contain a minimum of 1 items
A message type encapsulating the WhatsApp template syntax. It is currently used by MessageBird.
No Additional PropertiesThe type of this element.
Specific value:"whatsapp_template"
WhatsApp template element metadata.
No Additional PropertiesWhatsApp template name to use for this message.
Must be at least 1 characters long
WhatsApp namespace associated with the WABA. Defaults to the provider settings namespace.
Must be at least 1 characters long
For non-WhatsApp capable providers, it will be sent as a text message containing this string.
Must be at least 1 characters long
Language code of the template. Note that language policy of the template message will always be deterministic. Defaults to en.
Must be at least 1 characters long
Array of parameters in header component of the template message. Applies to media templates only.
No Additional ItemsType of header
Image header.
URL to the image.
Must match regular expression:^((https|s3|gs)\:\/\/|\$)
Video header.
URL to the videos.
Must match regular expression:^((https|s3|gs)\:\/\/|\$)
Document attachment in media template.
URL to the document.
Must match regular expression:^((https|s3|gs)\:\/\/|\$)
Caption to accompany the document attachment.
Must be at least 1 characters long
Filename of document attachment. If caption is not specified, filename will be used instead.
Must be at least 1 characters long
Array of parameters in body component of the template message. Applies to both text and media templates.
No Additional ItemsType of body.
Text to use in body parameter.
Text to use in body parameter.
An empty message with no content whatsoever.
No Additional PropertiesThe type of this element.
Specific value:"empty"
When specified, the message / carousel item can be favorited on the frontend.
Same definition as favoriteMessage.provider_metadata is used on Messages to provide additional context to the provider for delivery.
Delivery metadata for MessengerProvider.
Use MESSAGE_TAG when sending this message. This is useful when sending messages outside of the 24 hour window. Do make sure that the tag corresponds to the actual content of the message. See Message Tags documentation for more details on what content is allowed by each tag.
This is the schema for the ReplyTo metadata representing replyee message information
No Additional PropertiesThe UID of the replyee delivery object. Used when replyee edits/deletes their message.
Replied On datetime to track when we "copied" the replyee message (may be used to check if original message was edited post-reply)
This is the schema for messages as described and proposed in the Ratatoskr: Data Models for Messages RFC.
Same definition as MessageSeries of Ratatoskr Message.schemas will be sent to the user.
Must contain a minimum of 1 items
This is the schema for messages as described and proposed in the Ratatoskr: Data Models for Messages RFC.
Same definition as MessageChoose from one of the arrays of Ratatoskr Message.schemas randomly.
No Additional PropertiesArray of choices of messages to choose from.
Must contain a minimum of 1 items
An array of messages that form this random message choice.
Must contain a minimum of 1 items
This is the schema for messages as described and proposed in the Ratatoskr: Data Models for Messages RFC.
Same definition as MessageThe relative weight of this message used to perform weighted choice. Defaults to 1.
Value must be strictly greater than 0
Application settings for message testing. This is used by frontend for integration/E2E testing. Do not change unless you know what you are doing.
No Additional PropertiesAn array of query/responses pairs.
No Additional ItemsWhen application receives this query (case sensitive exact), the below messages will be sent.
Must be at least 1 characters long
Delivery metadata to associate with the delivery.
No Additional PropertiesWhether 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: objectThese messages are sent on receipt of the test queries.
No Additional ItemsThis is the schema for messages as described and proposed in the Ratatoskr: Data Models for Messages RFC.
No Additional PropertiesThe type of this element.
Specific value:"message"
Message element metadata.
Title primitive element.
No Additional PropertiesThe type of this element.
Specific value:"title"
Title content.
Must be at least 1 characters long
Subtitle primitive element.
No Additional PropertiesThe type of this element.
Specific value:"subtitle"
Subtitle content.
Must be at least 1 characters long
Text primitive element.
No Additional PropertiesThe type of this element.
Specific value:"text"
Text content.
Must be at least 1 characters long
Image primitive element.
No Additional PropertiesThe type of this element.
Specific value:"image"
Image element metadata.
URL to the image file.
Overrides frontend's default image scaling algorithm.
Action to take when clicking on the image (or preview image). Defaults to opening the image in viewer.
URL to the link file. Could be application internal links too. Currently supported internal links are: botmd://hospital/postMessage, botmd://hospital/emobot, botmd://hospital/gql, and `botmd://hospital/jarvisQuery.
Must be at least 1 characters long
Whether to open the url in an external browser instead of our own webview. Defaults to false.
The MIME type of the content at URL. This is guessed from the extension of the url. If it is a http/https URL and there are no file extensions, text/html is assumed.
This is useful to override the default app responsible for opening it.
See scalpel.messages.url.ContentTypeMixin for content type guessing logic.
Must be at least 1 characters long
Metadata to describe an event that can be posted to Shadowfax. This is usually part of an Actionable.
Event type that will be posted to Shadowfax (i.e., event_type) when this action is taken.
Must be at least 1 characters long
Optional event properties that will be posted to Shadowfax (i.e., event_properties) when this action is taken.
Additional Properties of any type are allowed.
Type: objectAdditional Properties of any type are allowed.
Type: objectAdditional Properties of any type are allowed.
Type: objectAudio primitive element.
No Additional PropertiesThe type of this element.
Specific value:"audio"
Audio element metadata.
URL to the audio file.
Preview image of audio. Defaults to a generic audio icon.
URL to the image file.
Overrides frontend's default image scaling algorithm.
Action to take when clicking on the image (or preview image). Defaults to opening the image in viewer.
URL to the link file. Could be application internal links too. Currently supported internal links are: botmd://hospital/postMessage, botmd://hospital/emobot, botmd://hospital/gql, and `botmd://hospital/jarvisQuery.
Must be at least 1 characters long
Whether to open the url in an external browser instead of our own webview. Defaults to false.
The MIME type of the content at URL. This is guessed from the extension of the url. If it is a http/https URL and there are no file extensions, text/html is assumed.
This is useful to override the default app responsible for opening it.
See scalpel.messages.url.ContentTypeMixin for content type guessing logic.
Must be at least 1 characters long
Metadata to describe an event that can be posted to Shadowfax. This is usually part of an Actionable.
Event type that will be posted to Shadowfax (i.e., event_type) when this action is taken.
Must be at least 1 characters long
Optional event properties that will be posted to Shadowfax (i.e., event_properties) when this action is taken.
Additional Properties of any type are allowed.
Type: objectAdditional Properties of any type are allowed.
Type: objectAdditional Properties of any type are allowed.
Type: objectAdditional Properties of any type are allowed.
Type: objectVideo primitive element.
No Additional PropertiesThe type of this element.
Specific value:"video"
Video element metadata.
URL to the video file.
Preview image of video. Defaults to first frame of video.
URL to the image file.
Overrides frontend's default image scaling algorithm.
Action to take when clicking on the image (or preview image). Defaults to opening the image in viewer.
URL to the link file. Could be application internal links too. Currently supported internal links are: botmd://hospital/postMessage, botmd://hospital/emobot, botmd://hospital/gql, and `botmd://hospital/jarvisQuery.
Must be at least 1 characters long
Whether to open the url in an external browser instead of our own webview. Defaults to false.
The MIME type of the content at URL. This is guessed from the extension of the url. If it is a http/https URL and there are no file extensions, text/html is assumed.
This is useful to override the default app responsible for opening it.
See scalpel.messages.url.ContentTypeMixin for content type guessing logic.
Must be at least 1 characters long
Metadata to describe an event that can be posted to Shadowfax. This is usually part of an Actionable.
Event type that will be posted to Shadowfax (i.e., event_type) when this action is taken.
Must be at least 1 characters long
Optional event properties that will be posted to Shadowfax (i.e., event_properties) when this action is taken.
Additional Properties of any type are allowed.
Type: objectAdditional Properties of any type are allowed.
Type: objectAdditional Properties of any type are allowed.
Type: objectWhether to auto play video in preview view. Defaults to false.
Additional Properties of any type are allowed.
Type: objectAttachment primitive element.
No Additional PropertiesThe type of this element.
Specific value:"attachment"
Attachment element metadata.
No Additional PropertiesURL to the attachment file.
Must match regular expression:^((https|s3|gs|file)\:\/\/|\$)
Filename for attachment. This is useful when the filename cannot be inferred from the URL.
Must be at least 1 characters long
The MIME type of the attachment. This is guessed from the extension of the filename followed by the url. See scalpel.messages.url.ContentTypeMixin for content type guessing logic.
Must be at least 1 characters long
Preview image of attachment. Defaults to first frame of attachment.
URL to the image file.
Overrides frontend's default image scaling algorithm.
Action to take when clicking on the image (or preview image). Defaults to opening the image in viewer.
URL to the link file. Could be application internal links too. Currently supported internal links are: botmd://hospital/postMessage, botmd://hospital/emobot, botmd://hospital/gql, and `botmd://hospital/jarvisQuery.
Must be at least 1 characters long
Whether to open the url in an external browser instead of our own webview. Defaults to false.
The MIME type of the content at URL. This is guessed from the extension of the url. If it is a http/https URL and there are no file extensions, text/html is assumed.
This is useful to override the default app responsible for opening it.
See scalpel.messages.url.ContentTypeMixin for content type guessing logic.
Must be at least 1 characters long
Metadata to describe an event that can be posted to Shadowfax. This is usually part of an Actionable.
Event type that will be posted to Shadowfax (i.e., event_type) when this action is taken.
Must be at least 1 characters long
Optional event properties that will be posted to Shadowfax (i.e., event_properties) when this action is taken.
Additional Properties of any type are allowed.
Type: objectAdditional Properties of any type are allowed.
Type: objectAdditional Properties of any type are allowed.
Type: objectEinstein-specific metadata for this attachment
Einstein Document UID for attachment.
Must be at least 1 characters long
Button action primitive element.
No Additional PropertiesThe type of this element.
Specific value:"button"
Quick reply primitive element.
No Additional PropertiesThe type of this element.
Specific value:"quick_reply"
Quick reply element metadata.
Metadata to describe the visual aspect of a quick reply.
Display text.
Must be at least 1 characters long
Additional Properties of any type are allowed.
Type: objectMetadata to describe actions that are taken when a UI element is triggered (e.g., tapped, clicked, etc).
Same definition as actionableLocation request primitive element.
No Additional PropertiesThe type of this element.
Specific value:"location_request"
Location request element metadata.
No Additional PropertiesPrompt for the user when requesting for location.
Must be at least 1 characters long
Location request primitive element.
No Additional PropertiesThe type of this element.
Specific value:"location_response"
Location response element metadata.
No Additional PropertiesLocation latitude.
Location longitude.
Name of the location.
Must be at least 1 characters long
Human-readable address of the location.
Must be at least 1 characters long
Container types wrap around other primitive types.
Quick replies container element.
No Additional PropertiesThe type of this element.
Specific value:"quick_replies"
Array of quick replys.
Must contain a minimum of 1 items
Must contain a maximum of 16 items
Sections are container types for up to at most 3 elements. These are most likely to be used for rich messages that include media, paragraphs, and actions.
No Additional PropertiesThe type of this element.
Specific value:"sections"
An array of section elements.
Must contain a minimum of 1 items
Must contain a maximum of 5 items
Paragraphs container element.
No Additional PropertiesThe type of this element.
Specific value:"paragraphs"
An array of paragraph elements.
Must contain a minimum of 1 items
Must contain a maximum of 3 items
When specified, the message / carousel item can be favorited on the frontend.
No Additional PropertiesTitle to show in the favorites menu.
Must be at least 1 characters long
URL to favorite item. This could be an internal botmd:// link or an external link.
Must be at least 1 characters long
This is used with botmd://hospital/jarvisQuery links using uids. If frontend decides to cache the content of this favorite message, it should be refreshed against the backend after the expiry.
Actions container element.
No Additional PropertiesThe type of this element.
Specific value:"actions"
An array of action elements.
Must contain a minimum of 1 items
Must contain a maximum of 8 items
When specified, the message / carousel item can be favorited on the frontend.
Same definition as favoriteWhen specified, the message / carousel item can be favorited on the frontend.
Same definition as favoriteCarousel container element.
No Additional PropertiesThe type of this element.
Specific value:"carousel"
Carousel element metadata.
Must contain a minimum of 1 items
Must contain a maximum of 10 items
Container types wrap around other primitive types. These types are used in carousels.
Sections are container types for up to at most 3 elements. These are most likely to be used for rich messages that include media, paragraphs, and actions.
Same definition as SectionsApplication payload message.
No Additional PropertiesThe type of this element.
Specific value:"application_payload"
Application payload element metadata.
No Additional PropertiesApplication origin of the data payload
Must be at least 1 characters long
Arbitrary payload to be used by application. Can be any JSON object.
Additional Properties of any type are allowed.
Type: objectThis is a high level representation of MIME emails.
No Additional PropertiesThe type of this element.
Specific value:"email"
Email element metadata.
A short string identifying the topic of the message (RFC 2822).
Must be at least 1 characters long
The main body of the email in plain text.
The main body of the email in HTML.
Must be at least 1 characters long
Attachments to the email.
Must contain a minimum of 1 items
A message type encapsulating the WhatsApp template syntax. It is currently used by MessageBird.
No Additional PropertiesThe type of this element.
Specific value:"whatsapp_template"
WhatsApp template element metadata.
No Additional PropertiesWhatsApp template name to use for this message.
Must be at least 1 characters long
WhatsApp namespace associated with the WABA. Defaults to the provider settings namespace.
Must be at least 1 characters long
For non-WhatsApp capable providers, it will be sent as a text message containing this string.
Must be at least 1 characters long
Language code of the template. Note that language policy of the template message will always be deterministic. Defaults to en.
Must be at least 1 characters long
Array of parameters in header component of the template message. Applies to media templates only.
No Additional ItemsType of header
Image header.
URL to the image.
Must match regular expression:^((https|s3|gs)\:\/\/|\$)
Video header.
URL to the videos.
Must match regular expression:^((https|s3|gs)\:\/\/|\$)
Document attachment in media template.
URL to the document.
Must match regular expression:^((https|s3|gs)\:\/\/|\$)
Caption to accompany the document attachment.
Must be at least 1 characters long
Filename of document attachment. If caption is not specified, filename will be used instead.
Must be at least 1 characters long
Array of parameters in body component of the template message. Applies to both text and media templates.
No Additional ItemsType of body.
Text to use in body parameter.
Text to use in body parameter.
An empty message with no content whatsoever.
No Additional PropertiesThe type of this element.
Specific value:"empty"
When specified, the message / carousel item can be favorited on the frontend.
Same definition as favoriteMessage.provider_metadata is used on Messages to provide additional context to the provider for delivery.
Delivery metadata for MessengerProvider.
Use MESSAGE_TAG when sending this message. This is useful when sending messages outside of the 24 hour window. Do make sure that the tag corresponds to the actual content of the message. See Message Tags documentation for more details on what content is allowed by each tag.
This is the schema for the ReplyTo metadata representing replyee message information
No Additional PropertiesThe UID of the replyee delivery object. Used when replyee edits/deletes their message.
Replied On datetime to track when we "copied" the replyee message (may be used to check if original message was edited post-reply)
This is the schema for messages as described and proposed in the Ratatoskr: Data Models for Messages RFC.
Same definition as MessageThe NoopApplication does nothing on all incoming messages and does not deliver any outgoing messages. If outgoing deliveries are desired, use NoopIncomingApplication instead.
The OTP forwarding application simply forwards incoming messages to another provider application.
No Additional PropertiesAn array of objects describing which provider application and destinations to forward to.
No Additional ItemsProvider application to forward the requests to. This can either be a name or uid.
Must be at least 1 characters long
Destination to forward to. This is usually email or E.164 phone numbers.
Must contain a minimum of 1 items
Must be at least 1 characters long
The keyword argument for upsert_device. Only email and phone based providers are currently supported. Defaults to phone.
Ratatoskr related settings.
No Additional PropertiesCheck the messages for subscribe requests and processes it in Ratatoskr. Defaults to true.
Check the messages for unsubscribe requests and processes it in Ratatoskr. Defaults to true.
Trigger phrases for subscribe process.
Must contain a minimum of 1 items
Must be at least 1 characters long
Messages to send out in response to an subscribe request. See code for default value.
No message will be sent.
Simple text message to send.
Must be at least 1 characters long
A text message will be uniformly selected from this array.
Must contain a minimum of 1 items
Must be at least 1 characters long
Ratatoskr Message.schema that will be sent to the user.
No Additional PropertiesThe type of this element.
Specific value:"message"
Message element metadata.
Title primitive element.
No Additional PropertiesThe type of this element.
Specific value:"title"
Title content.
Must be at least 1 characters long
Subtitle primitive element.
No Additional PropertiesThe type of this element.
Specific value:"subtitle"
Subtitle content.
Must be at least 1 characters long
Text primitive element.
No Additional PropertiesThe type of this element.
Specific value:"text"
Text content.
Must be at least 1 characters long
Image primitive element.
No Additional PropertiesThe type of this element.
Specific value:"image"
Image element metadata.
URL to the image file.
Overrides frontend's default image scaling algorithm.
Action to take when clicking on the image (or preview image). Defaults to opening the image in viewer.
URL to the link file. Could be application internal links too. Currently supported internal links are: botmd://hospital/postMessage, botmd://hospital/emobot, botmd://hospital/gql, and `botmd://hospital/jarvisQuery.
Must be at least 1 characters long
Whether to open the url in an external browser instead of our own webview. Defaults to false.
The MIME type of the content at URL. This is guessed from the extension of the url. If it is a http/https URL and there are no file extensions, text/html is assumed.
This is useful to override the default app responsible for opening it.
See scalpel.messages.url.ContentTypeMixin for content type guessing logic.
Must be at least 1 characters long
Metadata to describe an event that can be posted to Shadowfax. This is usually part of an Actionable.
Event type that will be posted to Shadowfax (i.e., event_type) when this action is taken.
Must be at least 1 characters long
Optional event properties that will be posted to Shadowfax (i.e., event_properties) when this action is taken.
Additional Properties of any type are allowed.
Type: objectAdditional Properties of any type are allowed.
Type: objectAdditional Properties of any type are allowed.
Type: objectAudio primitive element.
No Additional PropertiesThe type of this element.
Specific value:"audio"
Audio element metadata.
URL to the audio file.
Preview image of audio. Defaults to a generic audio icon.
URL to the image file.
Overrides frontend's default image scaling algorithm.
Action to take when clicking on the image (or preview image). Defaults to opening the image in viewer.
URL to the link file. Could be application internal links too. Currently supported internal links are: botmd://hospital/postMessage, botmd://hospital/emobot, botmd://hospital/gql, and `botmd://hospital/jarvisQuery.
Must be at least 1 characters long
Whether to open the url in an external browser instead of our own webview. Defaults to false.
The MIME type of the content at URL. This is guessed from the extension of the url. If it is a http/https URL and there are no file extensions, text/html is assumed.
This is useful to override the default app responsible for opening it.
See scalpel.messages.url.ContentTypeMixin for content type guessing logic.
Must be at least 1 characters long
Metadata to describe an event that can be posted to Shadowfax. This is usually part of an Actionable.
Event type that will be posted to Shadowfax (i.e., event_type) when this action is taken.
Must be at least 1 characters long
Optional event properties that will be posted to Shadowfax (i.e., event_properties) when this action is taken.
Additional Properties of any type are allowed.
Type: objectAdditional Properties of any type are allowed.
Type: objectAdditional Properties of any type are allowed.
Type: objectAdditional Properties of any type are allowed.
Type: objectVideo primitive element.
No Additional PropertiesThe type of this element.
Specific value:"video"
Video element metadata.
URL to the video file.
Preview image of video. Defaults to first frame of video.
URL to the image file.
Overrides frontend's default image scaling algorithm.
Action to take when clicking on the image (or preview image). Defaults to opening the image in viewer.
URL to the link file. Could be application internal links too. Currently supported internal links are: botmd://hospital/postMessage, botmd://hospital/emobot, botmd://hospital/gql, and `botmd://hospital/jarvisQuery.
Must be at least 1 characters long
Whether to open the url in an external browser instead of our own webview. Defaults to false.
The MIME type of the content at URL. This is guessed from the extension of the url. If it is a http/https URL and there are no file extensions, text/html is assumed.
This is useful to override the default app responsible for opening it.
See scalpel.messages.url.ContentTypeMixin for content type guessing logic.
Must be at least 1 characters long
Metadata to describe an event that can be posted to Shadowfax. This is usually part of an Actionable.
Event type that will be posted to Shadowfax (i.e., event_type) when this action is taken.
Must be at least 1 characters long
Optional event properties that will be posted to Shadowfax (i.e., event_properties) when this action is taken.
Additional Properties of any type are allowed.
Type: objectAdditional Properties of any type are allowed.
Type: objectAdditional Properties of any type are allowed.
Type: objectWhether to auto play video in preview view. Defaults to false.
Additional Properties of any type are allowed.
Type: objectAttachment primitive element.
No Additional PropertiesThe type of this element.
Specific value:"attachment"
Attachment element metadata.
No Additional PropertiesURL to the attachment file.
Must match regular expression:^((https|s3|gs|file)\:\/\/|\$)
Filename for attachment. This is useful when the filename cannot be inferred from the URL.
Must be at least 1 characters long
The MIME type of the attachment. This is guessed from the extension of the filename followed by the url. See scalpel.messages.url.ContentTypeMixin for content type guessing logic.
Must be at least 1 characters long
Preview image of attachment. Defaults to first frame of attachment.
URL to the image file.
Overrides frontend's default image scaling algorithm.
Action to take when clicking on the image (or preview image). Defaults to opening the image in viewer.
URL to the link file. Could be application internal links too. Currently supported internal links are: botmd://hospital/postMessage, botmd://hospital/emobot, botmd://hospital/gql, and `botmd://hospital/jarvisQuery.
Must be at least 1 characters long
Whether to open the url in an external browser instead of our own webview. Defaults to false.
The MIME type of the content at URL. This is guessed from the extension of the url. If it is a http/https URL and there are no file extensions, text/html is assumed.
This is useful to override the default app responsible for opening it.
See scalpel.messages.url.ContentTypeMixin for content type guessing logic.
Must be at least 1 characters long
Metadata to describe an event that can be posted to Shadowfax. This is usually part of an Actionable.
Event type that will be posted to Shadowfax (i.e., event_type) when this action is taken.
Must be at least 1 characters long
Optional event properties that will be posted to Shadowfax (i.e., event_properties) when this action is taken.
Additional Properties of any type are allowed.
Type: objectAdditional Properties of any type are allowed.
Type: objectAdditional Properties of any type are allowed.
Type: objectEinstein-specific metadata for this attachment
Einstein Document UID for attachment.
Must be at least 1 characters long
Button action primitive element.
No Additional PropertiesThe type of this element.
Specific value:"button"
Quick reply primitive element.
No Additional PropertiesThe type of this element.
Specific value:"quick_reply"
Quick reply element metadata.
Metadata to describe the visual aspect of a quick reply.
Display text.
Must be at least 1 characters long
Additional Properties of any type are allowed.
Type: objectMetadata to describe actions that are taken when a UI element is triggered (e.g., tapped, clicked, etc).
Same definition as actionableLocation request primitive element.
No Additional PropertiesThe type of this element.
Specific value:"location_request"
Location request element metadata.
No Additional PropertiesPrompt for the user when requesting for location.
Must be at least 1 characters long
Location request primitive element.
No Additional PropertiesThe type of this element.
Specific value:"location_response"
Location response element metadata.
No Additional PropertiesLocation latitude.
Location longitude.
Name of the location.
Must be at least 1 characters long
Human-readable address of the location.
Must be at least 1 characters long
Container types wrap around other primitive types.
Quick replies container element.
No Additional PropertiesThe type of this element.
Specific value:"quick_replies"
Array of quick replys.
Must contain a minimum of 1 items
Must contain a maximum of 16 items
Sections are container types for up to at most 3 elements. These are most likely to be used for rich messages that include media, paragraphs, and actions.
No Additional PropertiesThe type of this element.
Specific value:"sections"
An array of section elements.
Must contain a minimum of 1 items
Must contain a maximum of 5 items
Paragraphs container element.
No Additional PropertiesThe type of this element.
Specific value:"paragraphs"
An array of paragraph elements.
Must contain a minimum of 1 items
Must contain a maximum of 3 items
When specified, the message / carousel item can be favorited on the frontend.
No Additional PropertiesTitle to show in the favorites menu.
Must be at least 1 characters long
URL to favorite item. This could be an internal botmd:// link or an external link.
Must be at least 1 characters long
This is used with botmd://hospital/jarvisQuery links using uids. If frontend decides to cache the content of this favorite message, it should be refreshed against the backend after the expiry.
Actions container element.
No Additional PropertiesThe type of this element.
Specific value:"actions"
An array of action elements.
Must contain a minimum of 1 items
Must contain a maximum of 8 items
When specified, the message / carousel item can be favorited on the frontend.
Same definition as favoriteWhen specified, the message / carousel item can be favorited on the frontend.
Same definition as favoriteCarousel container element.
No Additional PropertiesThe type of this element.
Specific value:"carousel"
Carousel element metadata.
Must contain a minimum of 1 items
Must contain a maximum of 10 items
Container types wrap around other primitive types. These types are used in carousels.
Sections are container types for up to at most 3 elements. These are most likely to be used for rich messages that include media, paragraphs, and actions.
Same definition as SectionsApplication payload message.
No Additional PropertiesThe type of this element.
Specific value:"application_payload"
Application payload element metadata.
No Additional PropertiesApplication origin of the data payload
Must be at least 1 characters long
Arbitrary payload to be used by application. Can be any JSON object.
Additional Properties of any type are allowed.
Type: objectThis is a high level representation of MIME emails.
No Additional PropertiesThe type of this element.
Specific value:"email"
Email element metadata.
A short string identifying the topic of the message (RFC 2822).
Must be at least 1 characters long
The main body of the email in plain text.
The main body of the email in HTML.
Must be at least 1 characters long
Attachments to the email.
Must contain a minimum of 1 items
A message type encapsulating the WhatsApp template syntax. It is currently used by MessageBird.
No Additional PropertiesThe type of this element.
Specific value:"whatsapp_template"
WhatsApp template element metadata.
No Additional PropertiesWhatsApp template name to use for this message.
Must be at least 1 characters long
WhatsApp namespace associated with the WABA. Defaults to the provider settings namespace.
Must be at least 1 characters long
For non-WhatsApp capable providers, it will be sent as a text message containing this string.
Must be at least 1 characters long
Language code of the template. Note that language policy of the template message will always be deterministic. Defaults to en.
Must be at least 1 characters long
Array of parameters in header component of the template message. Applies to media templates only.
No Additional ItemsType of header
Image header.
URL to the image.
Must match regular expression:^((https|s3|gs)\:\/\/|\$)
Video header.
URL to the videos.
Must match regular expression:^((https|s3|gs)\:\/\/|\$)
Document attachment in media template.
URL to the document.
Must match regular expression:^((https|s3|gs)\:\/\/|\$)
Caption to accompany the document attachment.
Must be at least 1 characters long
Filename of document attachment. If caption is not specified, filename will be used instead.
Must be at least 1 characters long
Array of parameters in body component of the template message. Applies to both text and media templates.
No Additional ItemsType of body.
Text to use in body parameter.
Text to use in body parameter.
An empty message with no content whatsoever.
No Additional PropertiesThe type of this element.
Specific value:"empty"
When specified, the message / carousel item can be favorited on the frontend.
Same definition as favoriteMessage.provider_metadata is used on Messages to provide additional context to the provider for delivery.
Delivery metadata for MessengerProvider.
Use MESSAGE_TAG when sending this message. This is useful when sending messages outside of the 24 hour window. Do make sure that the tag corresponds to the actual content of the message. See Message Tags documentation for more details on what content is allowed by each tag.
This is the schema for the ReplyTo metadata representing replyee message information
No Additional PropertiesThe UID of the replyee delivery object. Used when replyee edits/deletes their message.
Replied On datetime to track when we "copied" the replyee message (may be used to check if original message was edited post-reply)
This is the schema for messages as described and proposed in the Ratatoskr: Data Models for Messages RFC.
Same definition as MessageSeries of Ratatoskr Message.schemas will be sent to the user.
Must contain a minimum of 1 items
This is the schema for messages as described and proposed in the Ratatoskr: Data Models for Messages RFC.
Same definition as MessageChoose from one of the arrays of Ratatoskr Message.schemas randomly.
No Additional PropertiesArray of choices of messages to choose from.
Must contain a minimum of 1 items
An array of messages that form this random message choice.
Must contain a minimum of 1 items
This is the schema for messages as described and proposed in the Ratatoskr: Data Models for Messages RFC.
Same definition as MessageThe relative weight of this message used to perform weighted choice. Defaults to 1.
Value must be strictly greater than 0
Trigger phrases for unsubscribe process.
Must contain a minimum of 1 items
Must be at least 1 characters long
Messages to send out in response to an unsubscribe request. See code for default value.
No message will be sent.
Simple text message to send.
Must be at least 1 characters long
A text message will be uniformly selected from this array.
Must contain a minimum of 1 items
Must be at least 1 characters long
Ratatoskr Message.schema that will be sent to the user.
No Additional PropertiesThe type of this element.
Specific value:"message"
Message element metadata.
Title primitive element.
No Additional PropertiesThe type of this element.
Specific value:"title"
Title content.
Must be at least 1 characters long
Subtitle primitive element.
No Additional PropertiesThe type of this element.
Specific value:"subtitle"
Subtitle content.
Must be at least 1 characters long
Text primitive element.
No Additional PropertiesThe type of this element.
Specific value:"text"
Text content.
Must be at least 1 characters long
Image primitive element.
No Additional PropertiesThe type of this element.
Specific value:"image"
Image element metadata.
URL to the image file.
Overrides frontend's default image scaling algorithm.
Action to take when clicking on the image (or preview image). Defaults to opening the image in viewer.
URL to the link file. Could be application internal links too. Currently supported internal links are: botmd://hospital/postMessage, botmd://hospital/emobot, botmd://hospital/gql, and `botmd://hospital/jarvisQuery.
Must be at least 1 characters long
Whether to open the url in an external browser instead of our own webview. Defaults to false.
The MIME type of the content at URL. This is guessed from the extension of the url. If it is a http/https URL and there are no file extensions, text/html is assumed.
This is useful to override the default app responsible for opening it.
See scalpel.messages.url.ContentTypeMixin for content type guessing logic.
Must be at least 1 characters long
Metadata to describe an event that can be posted to Shadowfax. This is usually part of an Actionable.
Event type that will be posted to Shadowfax (i.e., event_type) when this action is taken.
Must be at least 1 characters long
Optional event properties that will be posted to Shadowfax (i.e., event_properties) when this action is taken.
Additional Properties of any type are allowed.
Type: objectAdditional Properties of any type are allowed.
Type: objectAdditional Properties of any type are allowed.
Type: objectAudio primitive element.
No Additional PropertiesThe type of this element.
Specific value:"audio"
Audio element metadata.
URL to the audio file.
Preview image of audio. Defaults to a generic audio icon.
URL to the image file.
Overrides frontend's default image scaling algorithm.
Action to take when clicking on the image (or preview image). Defaults to opening the image in viewer.
URL to the link file. Could be application internal links too. Currently supported internal links are: botmd://hospital/postMessage, botmd://hospital/emobot, botmd://hospital/gql, and `botmd://hospital/jarvisQuery.
Must be at least 1 characters long
Whether to open the url in an external browser instead of our own webview. Defaults to false.
The MIME type of the content at URL. This is guessed from the extension of the url. If it is a http/https URL and there are no file extensions, text/html is assumed.
This is useful to override the default app responsible for opening it.
See scalpel.messages.url.ContentTypeMixin for content type guessing logic.
Must be at least 1 characters long
Metadata to describe an event that can be posted to Shadowfax. This is usually part of an Actionable.
Event type that will be posted to Shadowfax (i.e., event_type) when this action is taken.
Must be at least 1 characters long
Optional event properties that will be posted to Shadowfax (i.e., event_properties) when this action is taken.
Additional Properties of any type are allowed.
Type: objectAdditional Properties of any type are allowed.
Type: objectAdditional Properties of any type are allowed.
Type: objectAdditional Properties of any type are allowed.
Type: objectVideo primitive element.
No Additional PropertiesThe type of this element.
Specific value:"video"
Video element metadata.
URL to the video file.
Preview image of video. Defaults to first frame of video.
URL to the image file.
Overrides frontend's default image scaling algorithm.
Action to take when clicking on the image (or preview image). Defaults to opening the image in viewer.
URL to the link file. Could be application internal links too. Currently supported internal links are: botmd://hospital/postMessage, botmd://hospital/emobot, botmd://hospital/gql, and `botmd://hospital/jarvisQuery.
Must be at least 1 characters long
Whether to open the url in an external browser instead of our own webview. Defaults to false.
The MIME type of the content at URL. This is guessed from the extension of the url. If it is a http/https URL and there are no file extensions, text/html is assumed.
This is useful to override the default app responsible for opening it.
See scalpel.messages.url.ContentTypeMixin for content type guessing logic.
Must be at least 1 characters long
Metadata to describe an event that can be posted to Shadowfax. This is usually part of an Actionable.
Event type that will be posted to Shadowfax (i.e., event_type) when this action is taken.
Must be at least 1 characters long
Optional event properties that will be posted to Shadowfax (i.e., event_properties) when this action is taken.
Additional Properties of any type are allowed.
Type: objectAdditional Properties of any type are allowed.
Type: objectAdditional Properties of any type are allowed.
Type: objectWhether to auto play video in preview view. Defaults to false.
Additional Properties of any type are allowed.
Type: objectAttachment primitive element.
No Additional PropertiesThe type of this element.
Specific value:"attachment"
Attachment element metadata.
No Additional PropertiesURL to the attachment file.
Must match regular expression:^((https|s3|gs|file)\:\/\/|\$)
Filename for attachment. This is useful when the filename cannot be inferred from the URL.
Must be at least 1 characters long
The MIME type of the attachment. This is guessed from the extension of the filename followed by the url. See scalpel.messages.url.ContentTypeMixin for content type guessing logic.
Must be at least 1 characters long
Preview image of attachment. Defaults to first frame of attachment.
URL to the image file.
Overrides frontend's default image scaling algorithm.
Action to take when clicking on the image (or preview image). Defaults to opening the image in viewer.
URL to the link file. Could be application internal links too. Currently supported internal links are: botmd://hospital/postMessage, botmd://hospital/emobot, botmd://hospital/gql, and `botmd://hospital/jarvisQuery.
Must be at least 1 characters long
Whether to open the url in an external browser instead of our own webview. Defaults to false.
The MIME type of the content at URL. This is guessed from the extension of the url. If it is a http/https URL and there are no file extensions, text/html is assumed.
This is useful to override the default app responsible for opening it.
See scalpel.messages.url.ContentTypeMixin for content type guessing logic.
Must be at least 1 characters long
Metadata to describe an event that can be posted to Shadowfax. This is usually part of an Actionable.
Event type that will be posted to Shadowfax (i.e., event_type) when this action is taken.
Must be at least 1 characters long
Optional event properties that will be posted to Shadowfax (i.e., event_properties) when this action is taken.
Additional Properties of any type are allowed.
Type: objectAdditional Properties of any type are allowed.
Type: objectAdditional Properties of any type are allowed.
Type: objectEinstein-specific metadata for this attachment
Einstein Document UID for attachment.
Must be at least 1 characters long
Button action primitive element.
No Additional PropertiesThe type of this element.
Specific value:"button"
Quick reply primitive element.
No Additional PropertiesThe type of this element.
Specific value:"quick_reply"
Quick reply element metadata.
Metadata to describe the visual aspect of a quick reply.
Display text.
Must be at least 1 characters long
Additional Properties of any type are allowed.
Type: objectMetadata to describe actions that are taken when a UI element is triggered (e.g., tapped, clicked, etc).
Same definition as actionableLocation request primitive element.
No Additional PropertiesThe type of this element.
Specific value:"location_request"
Location request element metadata.
No Additional PropertiesPrompt for the user when requesting for location.
Must be at least 1 characters long
Location request primitive element.
No Additional PropertiesThe type of this element.
Specific value:"location_response"
Location response element metadata.
No Additional PropertiesLocation latitude.
Location longitude.
Name of the location.
Must be at least 1 characters long
Human-readable address of the location.
Must be at least 1 characters long
Container types wrap around other primitive types.
Quick replies container element.
No Additional PropertiesThe type of this element.
Specific value:"quick_replies"
Array of quick replys.
Must contain a minimum of 1 items
Must contain a maximum of 16 items
Sections are container types for up to at most 3 elements. These are most likely to be used for rich messages that include media, paragraphs, and actions.
No Additional PropertiesThe type of this element.
Specific value:"sections"
An array of section elements.
Must contain a minimum of 1 items
Must contain a maximum of 5 items
Paragraphs container element.
No Additional PropertiesThe type of this element.
Specific value:"paragraphs"
An array of paragraph elements.
Must contain a minimum of 1 items
Must contain a maximum of 3 items
When specified, the message / carousel item can be favorited on the frontend.
No Additional PropertiesTitle to show in the favorites menu.
Must be at least 1 characters long
URL to favorite item. This could be an internal botmd:// link or an external link.
Must be at least 1 characters long
This is used with botmd://hospital/jarvisQuery links using uids. If frontend decides to cache the content of this favorite message, it should be refreshed against the backend after the expiry.
Actions container element.
No Additional PropertiesThe type of this element.
Specific value:"actions"
An array of action elements.
Must contain a minimum of 1 items
Must contain a maximum of 8 items
When specified, the message / carousel item can be favorited on the frontend.
Same definition as favoriteWhen specified, the message / carousel item can be favorited on the frontend.
Same definition as favoriteCarousel container element.
No Additional PropertiesThe type of this element.
Specific value:"carousel"
Carousel element metadata.
Must contain a minimum of 1 items
Must contain a maximum of 10 items
Container types wrap around other primitive types. These types are used in carousels.
Sections are container types for up to at most 3 elements. These are most likely to be used for rich messages that include media, paragraphs, and actions.
Same definition as SectionsApplication payload message.
No Additional PropertiesThe type of this element.
Specific value:"application_payload"
Application payload element metadata.
No Additional PropertiesApplication origin of the data payload
Must be at least 1 characters long
Arbitrary payload to be used by application. Can be any JSON object.
Additional Properties of any type are allowed.
Type: objectThis is a high level representation of MIME emails.
No Additional PropertiesThe type of this element.
Specific value:"email"
Email element metadata.
A short string identifying the topic of the message (RFC 2822).
Must be at least 1 characters long
The main body of the email in plain text.
The main body of the email in HTML.
Must be at least 1 characters long
Attachments to the email.
Must contain a minimum of 1 items
A message type encapsulating the WhatsApp template syntax. It is currently used by MessageBird.
No Additional PropertiesThe type of this element.
Specific value:"whatsapp_template"
WhatsApp template element metadata.
No Additional PropertiesWhatsApp template name to use for this message.
Must be at least 1 characters long
WhatsApp namespace associated with the WABA. Defaults to the provider settings namespace.
Must be at least 1 characters long
For non-WhatsApp capable providers, it will be sent as a text message containing this string.
Must be at least 1 characters long
Language code of the template. Note that language policy of the template message will always be deterministic. Defaults to en.
Must be at least 1 characters long
Array of parameters in header component of the template message. Applies to media templates only.
No Additional ItemsType of header
Image header.
URL to the image.
Must match regular expression:^((https|s3|gs)\:\/\/|\$)
Video header.
URL to the videos.
Must match regular expression:^((https|s3|gs)\:\/\/|\$)
Document attachment in media template.
URL to the document.
Must match regular expression:^((https|s3|gs)\:\/\/|\$)
Caption to accompany the document attachment.
Must be at least 1 characters long
Filename of document attachment. If caption is not specified, filename will be used instead.
Must be at least 1 characters long
Array of parameters in body component of the template message. Applies to both text and media templates.
No Additional ItemsType of body.
Text to use in body parameter.
Text to use in body parameter.
An empty message with no content whatsoever.
No Additional PropertiesThe type of this element.
Specific value:"empty"
When specified, the message / carousel item can be favorited on the frontend.
Same definition as favoriteMessage.provider_metadata is used on Messages to provide additional context to the provider for delivery.
Delivery metadata for MessengerProvider.
Use MESSAGE_TAG when sending this message. This is useful when sending messages outside of the 24 hour window. Do make sure that the tag corresponds to the actual content of the message. See Message Tags documentation for more details on what content is allowed by each tag.
This is the schema for the ReplyTo metadata representing replyee message information
No Additional PropertiesThe UID of the replyee delivery object. Used when replyee edits/deletes their message.
Replied On datetime to track when we "copied" the replyee message (may be used to check if original message was edited post-reply)
This is the schema for messages as described and proposed in the Ratatoskr: Data Models for Messages RFC.
Same definition as MessageSeries of Ratatoskr Message.schemas will be sent to the user.
Must contain a minimum of 1 items
This is the schema for messages as described and proposed in the Ratatoskr: Data Models for Messages RFC.
Same definition as MessageChoose from one of the arrays of Ratatoskr Message.schemas randomly.
No Additional PropertiesArray of choices of messages to choose from.
Must contain a minimum of 1 items
An array of messages that form this random message choice.
Must contain a minimum of 1 items
This is the schema for messages as described and proposed in the Ratatoskr: Data Models for Messages RFC.
Same definition as MessageThe relative weight of this message used to perform weighted choice. Defaults to 1.
Value must be strictly greater than 0
Seconds since the last incoming delivery before we consider an outgoing delivery "unsolicited". Defaults to 3600.
Value must be greater or equal to 1
Rooster related settings. Covers email webhook-driven integration with Rooster.
No Additional PropertiesUID of Data Source that will be synced based on the incoming email information.
Must be at least 1 characters long