ProviderApplication.provider_settings are used to store provider-specific settings such as API keys.
Settings for AcuityProvider.
User ID generated by actuity. Obtain this information in Acuity Dashboard -> Integrations -> API -> Credentials.
Must be at least 1 characters long
API Key generated by actuity. Obtain this information in Acuity Dashboard -> Integrations -> API -> Credentials.
Must be at least 1 characters long
Settings for CalendlyProvider.
Personal access token for accessing the Calendly API obtained from API Integrations. We currently do not handle the OAuth 2.0 flow and will use the generated token in the Authorization: Bearer header
Must be at least 1 characters long
Signing key used to validate incoming webhook payload. This is a randomly generated string by the user.
Must be at least 16 characters long
The unique reference to the organization. Get it via the API from here.
Whether to use the Calendly API as a user or organization. Defaults to user.
Settings for CleoProvider.
API Key generated for cleo provider to decrypt webhook payload.
Must be at least 1 characters long
Settings for GoogleCalendarProvider.
Calendar identifier. You can get this via API (or the API explorer).
Must be at least 1 characters long
An arbitrary string delivered to the target address with each notification.
Must be at least 1 characters long
Specifies default start/end time for all day events.
No Additional PropertiesTimezone for the all day event. Defaults to UTC.
Must be at least 1 characters long
Start time in the calendar timezone. Defaults to 00:00.
End time in the calendar timezone. Defaults to 00:00.
The service account credentials.
Credential type. Must be service_account.
"service_account"
Private key associated with the credential.
Must be at least 1 characters long
Additional Properties of any type are allowed.
Type: objectResource ID returned by calendar events watch API. This can be found in the X-Goog-Resource-Id header of watch incoming webhooks and is also populated during the upsert_webhook call. This value is required during webhook deletion.
Must be at least 1 characters long
Events within this window will be synced.
No Additional PropertiesNumber of seconds before now to sync events. Defaults to 604800 (i.e., 7 days).
Value must be greater or equal to 1
Number of seconds after now to sync events. Defaults to 2592000 (i.e., 30 days).
Value must be greater or equal to 1
Sync token stored during the initial sync according to Synchronize Resources Efficiently guide. This is currently not used.
Must be at least 1 characters long
Date/time the sync token was updated. This is currently not used.
Settings for HummingBirdProvider.
API Key generated by HummingBird.
Must be at least 1 characters long
URL of HummingBird API server.
Must be at least 1 characters long
URL to get verification token from HummingBird server.
Must be at least 1 characters long
Settings for ICalendarProvider.
URL to download the calendar file from.
Must be at least 1 characters long
Token for triggering a sync via webhook.
Must be at least 16 characters long
Specifies default start/end time for all day events.
Same definition as all_day_eventSettings for MandayaProvider.
API Key generated by mandaya. This key will be used to decrypt webhook payload.
Must be at least 1 characters long
Settings for NoopProvider.
QAParser.settings describes how fields can be parsed and extracted out of QAPairs. The basis of QAParser is QAField which describe individual normalized values that are extracted.
During extraction, QAFields are iterated in a sequence for each QAPair to attempt extraction. As such, the order of precedence for non-array fields (i.e., is_array = false) are such that values extracted from later QAFields override earlier ones.
For array QAFields (i.e., is_array = true), the extracted values are concatenated together.
An array of Field describing the how and what to extract from a QAPair.
All items must be unique
No Additional ItemsA field describes how to identify and extract the value from a Question-Answer pair.
No Additional PropertiesThe extracted value will be associated with this key.
Must be at least 1 characters long
Regular expression pattern that will be used to search the question text. We use Python regular expressions and re.search for matching.
Must be at least 1 characters long
Type of the extracted value. Defaults to string.
- For number, we will convert the value to float. - For boolean, we support handling of non-zero numbers, yes, and true. All other values are deemed as false.
If is_array and there are multiple question-field matches, the entries will be grouped together into a list.
If not is_array and the answer value is already a list, only the first element will be used.
Defaults to false.
Set this to true to use case-sensitive regex search. Defaults to false.
Action to take during parser error. Defaults to raise.
Default value to use when this field is not set.
null
Normalize value to a specific set of choices using Regex. The first matching regex in this array will be used as the normalized choice. If no matches are found, the original string value is used. Only applies to string type.
Must contain a minimum of 0 items
Regular expression to match for normalization.
Must be at least 1 characters long
Choice to be returned by the parser.
Use the given format string for parsing date/datetime. Defaults to dateutil.parser.parse(value, dayfirst=True, default=today_midnight).
Must be at least 1 characters long
Use the given format string for parsing time. Defaults to dateutil.parser.parse(value, dayfirst=True, default=today_midnight).
Must be at least 1 characters long
For date-time fields that are date only, this will be the default time added to it. Defaults to 08:00.
Ensures that the timezone of any parsed DATETIME or TIME field is localized to this timezone. Defaults to UTC.
Must be at least 1 characters long