Setting up your Organisation's Configurations

This guide outlines how to set up the settings/integrations for your organization to ensure the smooth operation of various platform services.

Below, we provide a breakdown of the different configuration categories, their purposes, and how to set them up securely.

Configuration Categories Overview

Setting Category	Description
Jira (JIRA)	Integrates with Jira for issue tracking and project management.
Open Tele (OPEN_TELE)	Configures information for integration with services like 100ms
RingCentral (RINGCENTRAL)	Configures communication through RingCentral services.
Oura Ring (OURA)	Manages integration with Oura Ring services for health monitoring.
Scheduling (SCHEDULING)	Configures appointment booking parameters.
General (GENERAL)	General configuration for notifications, time zones, and role overrides.
Firebase (FIREBASE)	Enables push notifications services for mobile and web apps.
Cloudflare (CLOUDFLARE)	Manages cloud storage services for assets and files.
Auth0 (AUTH0)	Configures identity management and authentication services.
Email (EMAIL)	Manages email communications, including SMTP credentials and email templates.
Twilio (TWILLIO)	Handles SMS and messaging services for appointment notifications

1. Retrieving Organization Settings

Before configuring settings, you must retrieve your current settings. Use the following cURL command to retrieve your settings based on your organization_code:

curl --location --globoff '{{PlatformBaseUrl}}/api/config/setting-type-mapping' \\
--header 'organization_code: organization-code'

Example Response

The response will contain all configurable settings, each grouped by their category.

[
    {
        "settingCategory": "EMAIL",
        "settings": [
            {
                "settingType": "EMAIL_CONFIG_HOST",
                "name": "EMAIL_CONFIG_HOST - EMAIL",
                "id": 9
            }
        ]
    },
    {
        "settingCategory": "TWILLIO",
        "settings": [
            {
                "settingType": "TWILLIO_PHONE_NUMBER",
                "name": "TWILLIO_PHONE_NUMBER - TWILLIO",
                "id": 1
            }
        ]
    }
]

2. Setting Configuration Values via API

To modify the organization’s configuration, you must use the Set Configuration API.

Note that only the owner of the organization or developers with config permissions can update these settings.

Example API Request to Set a Configuration:

To set configurations via the API, use the following curl command:

curl --location --request POST '{{PlatformBaseUrl}}/api/config/set' \
--header 'Content-Type: application/json' \
--data-raw '{"key":"value"}'

3. Table of Settings and Their Categories

Below is a summary table of all configurable settings and their associated categories.

Category	Setting Name	Description
TWILLIO	TWILLIO_PHONE_NUMBER	Phone number used for sending SMS via Twilio.
TWILLIO	TWILLIO_SID	Twilio account SID for authentication.
TWILLIO	TWILLIO_AUTH_TOKEN	Twilio authentication token for API access.
TWILLIO	TWILLIO_REFRESH_TOKEN	Token for refreshing Twilio authentication.
TWILLIO	TWILIO_MESSAGE_SERVICE_SID	SID for Twilio message services.
TWILLIO	SMS_APPOINTMENT_BOOKED_TEMPLATE	Template for booked appointment SMS notifications.
TWILLIO	SMS_APPOINTMENT_CANCELLED_TEMPLATE	Template for cancelled appointment SMS notifications.
TWILLIO	SMS_APPOINTMENT_REMINDER_TEMPLATE	Template for appointment reminder SMS notifications.
EMAIL	EMAIL_CONFIG_HOST	SMTP server host for sending emails.
EMAIL	EMAIL_CONFIG_USER	Username for email server authentication.
EMAIL	EMAIL_CONFIG_PASS	Password for email server authentication.
EMAIL	EMAIL_CONFIG_SENDER	Sender's email address.
EMAIL	EMAIL_APPOINTMENT_BOOKED_TEMPLATE	Template for booked appointment email notifications.
EMAIL	EMAIL_APPOINTMENT_CANCELLED_TEMPLATE	Template for cancelled appointment email notifications.
EMAIL	EMAIL_CONSUMER_AGREEMENT_TEMPLATE	Template for consumer agreement emails.
AUTH0	AUTH0_DOMAIN	Domain for Auth0 identity management.
AUTH0	AUTH0_AUDIENCE	Audience parameter for Auth0 authentication.
AUTH0	AUTH0_CLIENT_ID	Client ID for Auth0 applications.
AUTH0	AUTH0_CLIENT_ID_MANAGMENT	Client ID for Auth0 management API.
AUTH0	AUTH0_CLIENT_SECRET_MANAGMENT	Client secret for Auth0 management API.
AUTH0	AUTH0_CLIENT_SECRET	Client secret for Auth0 applications.
AUTH0	AUTH0_OTP_AUTH_VERIFY_URL	URL for OTP verification in Auth0.
AUTH0	AUTH0_OTP_AUTH_URL	URL for OTP authentication in Auth0.
CLOUDFLARE	CLOUDFLARE_R2_ACCOUNT_ID	Account ID for Cloudflare R2 storage.
CLOUDFLARE	CLOUDFLARE_R2_ACCESS_KEY	Access key for Cloudflare R2 storage.
CLOUDFLARE	CLOUDFLARE_R2_SECRET_KEY	Secret key for Cloudflare R2 storage.
CLOUDFLARE	CLOUDFLARE_R2_BUCKET_NAME	Bucket name for Cloudflare R2 storage.
FIREBASE	FIREBASE_SERVER_KEY	Server key for Firebase push notifications.
FIREBASE	FIREBASE_SERVICE_ACCOUNT	Service account key for Firebase.
FIREBASE	WELKIN_FIREBASE_SENDER_KEY	Sender key for Welkin Firebase integration.
FIREBASE	WELKIN_FIREBASE_SERVER_KEY	Server key for Welkin Firebase integration.
GENERAL	NOTIFICATION_CATEGORIES	List of available notification categories.
GENERAL	TIME_ZONE	Default time zone for the organization.
SCHEDULING	ALLOW_PAST_DAY_BOOKING	Whether booking on past dates is allowed.
RINGCENTRAL	RINGCENTRAL_CLIENT_ID	Client ID for RingCentral.
GENERAL	HMS_APP_ACCESS_KEY	Access key for HMS application.

Authentication Configuration Setup

The authentication configuration is essential for managing user access to services, including consumers, providers, and service accounts. Below are the key settings required for setting up authentication:

Example Setup for Auth0:

• OTP Verification URLs: Used to handle OTP-based authentication flows.

• Client Secrets: Ensure these are stored securely and are not exposed.

• Auth0 Domain: Defines the identity management domain for authentication.

API Configuration

Use the following to set up your API configuration:

POST {{PlatformBaseUrl}}/api/config/set

Headers

• organization_code: dev-sandbox

• Content-Type: application/json

Data

{
  "value": "your-auth0-domain.auth0.com",
  "settingType": "AUTH0_DOMAIN"
}

Ensure that your setup is completed to enable seamless access