Home Schema Example JSON Schema

Link Metadata

Type: object

Metadata for Stitch links.

No Additional Properties

Delayed

Type: object

This is used to store information about delayed link, such as status.

No Additional Properties

Filename

Type: string

File name of generated link. This is used to generate the correct file extensions for the stitch link and is used in the default waiting message.

Must be at least 1 characters long

Status

Type: enum (of string)

Status of the delayed link.

Must be one of:

  • "queued"
  • "in_progress"
  • "ready"
  • "failed"

Delay Function

Type: string

Python path to delayed task/function that generates data for the link. Used for debugging purposes.

Must be at least 1 characters long

Refresh Interval

Type: integer

Set the refresh interval for the message page while delayed link is in progress. Defaults to 10 seconds.

Value must be greater or equal to 1

Waiting Message

Type: string

This message is displayed to the user when the link is not ready yet (i.e., queued or in_progress status). Defaults to Please wait while we prepare ${filename}. It will be ready shortly..

Must be at least 1 characters long

Failed Message

Type: string

This message is displayed to the user when the link generation has failed (i.e., failed status). Defaults to We were unable to prepare ${filename}. Please contact the link owner for more information..

Must be at least 1 characters long

Stream Response

Type: boolean

Whether to stream the response rather than redirect (default: False)

Ready Message

Type: string

This message is displayed to the user when the link is ready but source_url is empty. Defaults to None. If both this and source_url is not set, a 404 will be returned to the user.

Must be at least 1 characters long

Expired Message

Type: string

This message is displayed to the user when the link is expired. If this is not set, 404 will be returned. Defaults to None.

Must be at least 1 characters long

Link Tracking Metadata

Type: object

Metadata for tracking link creation and context

No Additional Properties

Type: string or null

Patient's unique identifier

Type: string or null

Clinic's unique identifier