Home Schema Example JSON Schema

Provider Settings


ProviderApplication.provider_settings are used to store provider-specific settings such as API keys.

No Additional Properties

Type: object

The following properties are required:

  • budibase
Type: object

The following properties are required:

  • calendly
Type: object

The following properties are required:

  • cleo
Type: object

The following properties are required:

  • concerto
Type: object

The following properties are required:

  • formsg
Type: object

The following properties are required:

  • google_form
Type: object

The following properties are required:

  • mandaya
Type: object

The following properties are required:

  • tabular
Type: object

The following properties are required:

  • typeform

Budibase

Type: object

Settings for Budibase forms.

No Additional Properties

Base URL

Type: stringFormat: uri

Base URL for Budibase web application, e.g., https://ymir.production.botmd.io.

Must be at least 1 characters long

CouchDB URL

Type: stringFormat: uri

The CouchDB installation associated with the Budibase deployment. This is used for updating the Budibase forms. Should include auth credentials.

Must be at least 1 characters long

Minio URL

Type: stringFormat: uri

The MinIO installation associated with the Budibase deployment. This is used for deleting files from Minio. Should include auth credentials and bucket in the path, e.g., https://hippocrates-onform:xxxxx@ymir-minio.staging-private.botmd.io/bucket-name. If bucket is not specified, it will default to prod-budi-app-assets.

Must be at least 1 characters long

Attachment Expiration (Days)

Type: integer

The number of days before we delete the attachments from the MinIO storage. Defaults to 3 days.

Value must be greater or equal to 1

Webhook Token

Type: string

Webhook token used to authenticate against our endpoints. This token is usually generated by the user. Can be overridden in Form settings and must be set either here or in the form.

Must be at least 1 characters long

Calendly

Type: object

Settings for Calendly forms.

No Additional Properties

API key

Type: string

API key for accessing the Calendly API.

Must be at least 1 characters long

Signing key

Type: string

Signing key used to validate incoming webhook payload.

Must be at least 1 characters long

Cleo

Type: object

Settings for Cleo forms.

No Additional Properties

API key

Type: string

API key for verifying incoming requests.

Must be at least 1 characters long

Concerto

Type: object

Settings for Concerto forms.

No Additional Properties

Webhook Token

Type: string

Webhook token for verifying incoming requests.

Must be at least 1 characters long

Client Code

Type: string

Client code of incoming payloads should match this. If left empty, matching will not happen.

Must be at least 1 characters long

FormSG

Type: object

Settings for FormSG forms.

No Additional Properties

Admin Email

Type: stringFormat: email

Email address for logging in to admin account. Note that the admin email account should forward all emails from `containingOTPin the subject toformsg@{staging,production}.botmd.io` (or whichever address is configured by the FormSG OTP Ratatoskr application).

Webhook URL

Type: stringFormat: uri

Override the server webhook URL during request integrity check.

Google Form

Type: object

Settings for Google Forms.

No Additional Properties

Webhook Token

Type: string

Webhook token used to authenticate against our endpoints. This token is usually generated by the user and will match the api token in the code snippet.

Must be at least 32 characters long

Mandaya

Type: object

Settings for Mandaya forms.

No Additional Properties

API key

Type: string

API key for verifying incoming requests.

Must be at least 1 characters long

Tabular Interface

Type: object

Settings for Tabular interface forms. This can be an empty dictionary.

No Additional Properties

Tabular Interface

Type: object

Settings for using scalpel.externals.TabularInterface. When this key is used, TabularInterface.from_url(...) is used to load the source data.

Type: object

The following properties are required:

  • url
Type: object

The following properties are required:

  • urls

URL

Type: string

The URL containing tabular data.

Must be at least 1 characters long

URLs

Type: array of string

URLs containing tabular data (for use when data is split into multiple tables).

Must contain a minimum of 1 items

No Additional Items

Each item of this array must be:

Type: string

Must be at least 1 characters long

Sheet Name

Type: string

Name of the sheet in a workbook

Must be at least 1 characters long

Status Column

Type: string

Used to denote which is the Status column. Defaults to Status.

If any of development, staging, production, test appears in the status column, the row will be ignored unless it is executed in the same environment (as denoted by settings.ENVIRONMENT).

If ignore appears in the status column, the row is ignored.

Must be at least 1 characters long

Headers

Type: array of string

An array of string to denote the headers for the TabularInterface. Useful if the source data does not define headers.

Must contain a minimum of 1 items

No Additional Items

Each item of this array must be:

Type: string

Must be at least 1 characters long

Skip Header Row

Type: boolean

Whether to skip the header row.

This is a misnomer. It refers to whether the source data contains a header row.

When set to true, every row of the source data is read.

When set to false (default behavior), the first row of the data is treated as the headers value and data starts from the 2nd row onwards.

Each additional property must conform to the following schema

Type: object

Additional properties will be passed on to the __init__ for the TabularInterface reader.

Airtable

Type: object

Settings for using scalpel.externals.Airtable.

Type: object

The following properties are required:

  • url
Type: object

The following properties are required:

  • urls

URL

Type: string

The URL containing tabular data.

Must be at least 1 characters long

URLs

Type: array of string

URLs containing tabular data (for use when data is split into multiple tables).

Must contain a minimum of 1 items

No Additional Items

Each item of this array must be:

Type: string

Must be at least 1 characters long

Sheet Name

Type: string

Name of the sheet in a workbook

Must be at least 1 characters long

Status Column

Type: string

Used to denote which is the Status column. Defaults to Status.

If any of development, staging, production, test appears in the status column, the row will be ignored unless it is executed in the same environment (as denoted by settings.ENVIRONMENT).

If ignore appears in the status column, the row is ignored.

Must be at least 1 characters long

Headers

Type: array of string

An array of string to denote the headers for the TabularInterface. Useful if the source data does not define headers.

Must contain a minimum of 1 items

No Additional Items

Each item of this array must be:

Type: string

Must be at least 1 characters long

Skip Header Row

Type: boolean

Whether to skip the header row.

This is a misnomer. It refers to whether the source data contains a header row.

When set to true, every row of the source data is read.

When set to false (default behavior), the first row of the data is treated as the headers value and data starts from the 2nd row onwards.

Each additional property must conform to the following schema

Type: object

Additional properties will be passed on to the __init__ for the TabularInterface reader.

CSV

Type: object

Settings for using scalpel.externals.TabularCSV.

Type: object

The following properties are required:

  • url
Type: object

The following properties are required:

  • urls

URL

Type: string

The URL containing tabular data.

Must be at least 1 characters long

URLs

Type: array of string

URLs containing tabular data (for use when data is split into multiple tables).

Must contain a minimum of 1 items

No Additional Items

Each item of this array must be:

Type: string

Must be at least 1 characters long

Sheet Name

Type: string

Name of the sheet in a workbook

Must be at least 1 characters long

Status Column

Type: string

Used to denote which is the Status column. Defaults to Status.

If any of development, staging, production, test appears in the status column, the row will be ignored unless it is executed in the same environment (as denoted by settings.ENVIRONMENT).

If ignore appears in the status column, the row is ignored.

Must be at least 1 characters long

Headers

Type: array of string

An array of string to denote the headers for the TabularInterface. Useful if the source data does not define headers.

Must contain a minimum of 1 items

No Additional Items

Each item of this array must be:

Type: string

Must be at least 1 characters long

Skip Header Row

Type: boolean

Whether to skip the header row.

This is a misnomer. It refers to whether the source data contains a header row.

When set to true, every row of the source data is read.

When set to false (default behavior), the first row of the data is treated as the headers value and data starts from the 2nd row onwards.

Each additional property must conform to the following schema

Type: object

Additional properties will be passed on to the __init__ for the TabularInterface reader.

Google Sheets

Type: object

Settings for using scalpel.externals.GoogleSheets.

Type: object

The following properties are required:

  • url
Type: object

The following properties are required:

  • urls

URL

Type: string

The URL containing tabular data.

Must be at least 1 characters long

URLs

Type: array of string

URLs containing tabular data (for use when data is split into multiple tables).

Must contain a minimum of 1 items

No Additional Items

Each item of this array must be:

Type: string

Must be at least 1 characters long

Sheet Name

Type: string

Name of the sheet in a workbook

Must be at least 1 characters long

Status Column

Type: string

Used to denote which is the Status column. Defaults to Status.

If any of development, staging, production, test appears in the status column, the row will be ignored unless it is executed in the same environment (as denoted by settings.ENVIRONMENT).

If ignore appears in the status column, the row is ignored.

Must be at least 1 characters long

Headers

Type: array of string

An array of string to denote the headers for the TabularInterface. Useful if the source data does not define headers.

Must contain a minimum of 1 items

No Additional Items

Each item of this array must be:

Type: string

Must be at least 1 characters long

Skip Header Row

Type: boolean

Whether to skip the header row.

This is a misnomer. It refers to whether the source data contains a header row.

When set to true, every row of the source data is read.

When set to false (default behavior), the first row of the data is treated as the headers value and data starts from the 2nd row onwards.

Each additional property must conform to the following schema

Type: object

Additional properties will be passed on to the __init__ for the TabularInterface reader.

Google Sheets

Type: object

Settings for using scalpel.externals.GoogleSheets.

Type: object

The following properties are required:

  • url
Type: object

The following properties are required:

  • urls

URL

Type: string

The URL containing tabular data.

Must be at least 1 characters long

URLs

Type: array of string

URLs containing tabular data (for use when data is split into multiple tables).

Must contain a minimum of 1 items

No Additional Items

Each item of this array must be:

Type: string

Must be at least 1 characters long

Sheet Name

Type: string

Name of the sheet in a workbook

Must be at least 1 characters long

Status Column

Type: string

Used to denote which is the Status column. Defaults to Status.

If any of development, staging, production, test appears in the status column, the row will be ignored unless it is executed in the same environment (as denoted by settings.ENVIRONMENT).

If ignore appears in the status column, the row is ignored.

Must be at least 1 characters long

Headers

Type: array of string

An array of string to denote the headers for the TabularInterface. Useful if the source data does not define headers.

Must contain a minimum of 1 items

No Additional Items

Each item of this array must be:

Type: string

Must be at least 1 characters long

Skip Header Row

Type: boolean

Whether to skip the header row.

This is a misnomer. It refers to whether the source data contains a header row.

When set to true, every row of the source data is read.

When set to false (default behavior), the first row of the data is treated as the headers value and data starts from the 2nd row onwards.

Each additional property must conform to the following schema

Type: object

Additional properties will be passed on to the __init__ for the TabularInterface reader.

Excel

Type: object

Settings for using scalpel.externals.ExcelXLSX.

Type: object

The following properties are required:

  • url
Type: object

The following properties are required:

  • urls

URL

Type: string

The URL containing tabular data.

Must be at least 1 characters long

URLs

Type: array of string

URLs containing tabular data (for use when data is split into multiple tables).

Must contain a minimum of 1 items

No Additional Items

Each item of this array must be:

Type: string

Must be at least 1 characters long

Sheet Name

Type: string

Name of the sheet in a workbook

Must be at least 1 characters long

Status Column

Type: string

Used to denote which is the Status column. Defaults to Status.

If any of development, staging, production, test appears in the status column, the row will be ignored unless it is executed in the same environment (as denoted by settings.ENVIRONMENT).

If ignore appears in the status column, the row is ignored.

Must be at least 1 characters long

Headers

Type: array of string

An array of string to denote the headers for the TabularInterface. Useful if the source data does not define headers.

Must contain a minimum of 1 items

No Additional Items

Each item of this array must be:

Type: string

Must be at least 1 characters long

Skip Header Row

Type: boolean

Whether to skip the header row.

This is a misnomer. It refers to whether the source data contains a header row.

When set to true, every row of the source data is read.

When set to false (default behavior), the first row of the data is treated as the headers value and data starts from the 2nd row onwards.

Each additional property must conform to the following schema

Type: object

Additional properties will be passed on to the __init__ for the TabularInterface reader.

Typeform

Type: object

Settings for Typeform forms.

No Additional Properties

API Key

Type: string

API key for accessing the Typeform API.

Must be at least 1 characters long

Delete Submissions

Type: integer

Delete submissions that are older than N days. If N=0, submissions are never deleted. Defaults to 30 days.

Value must be greater or equal to 0