### Get Project Key from Select Widget Example Source: https://github.com/appsmithorg/appsmith-docs/blob/main/website/docs/connect-data/reference/jira.md This example shows how to dynamically get a project key from a Select widget. This key is used to fetch issue statuses or assignable users for a given project. ```javascript {{ selectProject.selectedOptionValue }} ``` -------------------------------- ### Get Project Key Example Source: https://github.com/appsmithorg/appsmith-docs/blob/main/website/docs/connect-data/reference/jira.md This example shows how to retrieve a project key from a URL. It is used to filter issues within a specific Jira project. ```javascript https://your-domain.atlassian.net/browse/CUSTOMER_SUPPORT ``` -------------------------------- ### Get Project Key Dynamically Example Source: https://github.com/appsmithorg/appsmith-docs/blob/main/website/docs/connect-data/reference/jira.md This example shows how to dynamically fetch a project key from an Input widget. This is used to ensure the retrieved schema is relevant to the specific project's configuration. ```javascript {{ inputProjectKey.text }} ``` -------------------------------- ### Calendar Get Availability Time Min Example Source: https://github.com/appsmithorg/appsmith-docs/blob/main/website/docs/connect-data/reference/google-calendar.md Specifies the start of the availability interval in ISO 8601 format. ```text 2025-06-01T09:00:00-07:00 ``` -------------------------------- ### Install dependencies Source: https://github.com/appsmithorg/appsmith-docs/blob/main/README.md Install the required node modules using the package.json file. ```bash $ npm install package.json ``` -------------------------------- ### Custom Action GET Calendar Colors Example Source: https://github.com/appsmithorg/appsmith-docs/blob/main/website/docs/connect-data/reference/google-calendar.md Example for a custom query to retrieve calendar colors. Requires appropriate authentication and permissions. ```http GET /colors ``` -------------------------------- ### Mixpanel From Date Example Source: https://github.com/appsmithorg/appsmith-docs/blob/main/website/docs/connect-data/reference/mixpanel.md Specify the start date for the query in YYYY-MM-DD format. This is a required field. ```text 2025-10-01 ``` -------------------------------- ### Example Meeting Start Time Source: https://github.com/appsmithorg/appsmith-docs/blob/main/website/docs/connect-data/reference/zoom.md Specify the scheduled start time for the meeting in ISO 8601 format (UTC). The format should be: YYYY-MM-DDThh:mm:ssZ. ```text 2025-06-15T14:00:00Z ``` -------------------------------- ### Filename Specification Example Source: https://github.com/appsmithorg/appsmith-docs/blob/main/website/docs/connect-data/reference/google-drive.md Example of a filename string for the save command. ```text report_2023.xlsx ``` -------------------------------- ### Example Updated Meeting Start Time Source: https://github.com/appsmithorg/appsmith-docs/blob/main/website/docs/connect-data/reference/zoom.md Provide the updated scheduled start time for the meeting in ISO 8601 format (UTC). ```text 2025-06-16T15:00:00Z ``` -------------------------------- ### Select Operation Example Source: https://github.com/appsmithorg/appsmith-docs/blob/main/website/docs/connect-data/reference/jira.md This example demonstrates how to dynamically fetch an operation from a Select widget. This specifies the type of action to describe, such as edit, transition, or comment. ```javascript {{ selectOperation.selectedOptionValue }} ``` -------------------------------- ### View Kubernetes Resources Source: https://github.com/appsmithorg/appsmith-docs/blob/main/website/docs/getting-started/setup/installation-guides/kubernetes/migrate-k8s.md Use the `kubectl get all` command to list all resources associated with your current Appsmith deployment in Kubernetes. This helps in understanding the existing setup before migration. ```bash ➜ kubectl get all NAME READY STATUS RESTARTS AGE pod/appsmith-editor-995c974df-njtdh 1/1 Running 0 3d12h pod/appsmith-internal-server-dfd68b55b-8p5w8 1/1 Running 1 3d12h pod/imago-27473940-kwslt 0/1 Completed 0 12m pod/mongo-statefulset-0 1/1 Running 0 3d12h pod/redis-statefulset-0 1/1 Running 0 3d12h NAME TYPE CLUSTER-IP EXTERNAL-IP PORT(S) AGE service/appsmith-backend-service NodePort 10.100.247.245 8080:32694/TCP 3d12h service/appsmith-editor ClusterIP 10.100.236.17 80/TCP 3d12h service/kubernetes ClusterIP 10.100.0.1 443/TCP 3d12h service/mongo-service NodePort 10.100.2.162 27017:31766/TCP 3d12h service/redis-service NodePort 10.100.7.184 6379:30834/TCP 3d12h NAME READY UP-TO-DATE AVAILABLE AGE deployment.apps/appsmith-editor 1/1 1 1 3d12h deployment.apps/appsmith-internal-server 1/1 1 1 3d12h NAME DESIRED CURRENT READY AGE replicaset.apps/appsmith-editor-995c974df 1 1 1 3d12h replicaset.apps/appsmith-internal-server-dfd68b55b 1 1 1 3d12h NAME READY AGE statefulset.apps/mongo-statefulset 1/1 3d12h statefulset.apps/redis-statefulset 1/1 3d12h NAME SCHEDULE SUSPEND ACTIVE LAST SCHEDULE AGE cronjob.batch/imago 0 * * * * False 0 12m 3d12h NAME COMPLETIONS DURATION AGE job.batch/imago-27473940 1/1 16s 12m ``` -------------------------------- ### Unsupported Library URL Examples Source: https://github.com/appsmithorg/appsmith-docs/blob/main/website/docs/core-concepts/writing-code/ext-libraries.md Examples of invalid library URLs that do not meet compatibility requirements. ```javascript ❌ https://cdn.jsdelivr.net/npm/uuid@9.0.0/dist/index.js ``` ```javascript ❌ https://www.jsdelivr.com/package/npm/datejs ``` -------------------------------- ### Verify helm-mapkubeapis Plugin Installation Source: https://github.com/appsmithorg/appsmith-docs/blob/main/website/docs/help-and-support/troubleshooting-guide/deployment-error-guides/k8s-helm3.0.4-upgrade-error.md Confirm that the `helm-mapkubeapis` plugin has been successfully installed. This command lists all installed Helm plugins. ```bash helm plugin ls ``` -------------------------------- ### Deploy Appsmith Source: https://github.com/appsmithorg/appsmith-docs/blob/main/website/docs/getting-started/setup/upgrade-from-community-edition/kubernetes.md Installs the Appsmith chart into a specified namespace. ```bash # Give a desired name to your namespace by replacing helm install appsmith appsmith-ee/appsmith -n --create-namespace ``` -------------------------------- ### showModal() - Usage Examples Source: https://github.com/appsmithorg/appsmith-docs/blob/main/website/docs/reference/appsmith-framework/widget-actions/show-modal.md Examples demonstrating how to use the showModal() function in different scenarios within Appsmith. ```APIDOC ## Usage Examples ### Show Modal using JS Enable the *JS* toggle and use the following code: ```javascript {{ showModal(ProductDetailsModal.name) }} ``` ### Show Modal on page load Use a JSObject to call `showModal()` and enable the **Run on Page Load** toggle. ```javascript // JSObject code export default { showMyModal() { showModal(UserDetailsModal.name); } } // Enable "Run on Page Load" from JSObject settings ``` ### Show Modals conditionally Implement conditional logic based on user attributes or data. For example, in a button's **onClick** event: ```javascript // Enable JS next to the event and add the code {{currentRow.role === 'admin' ? showModal(adminModal.name) : showModal(userModal.name)}} ``` ``` -------------------------------- ### Install Appsmith Helm Chart Source: https://github.com/appsmithorg/appsmith-docs/blob/main/website/docs/getting-started/setup/installation-guides/kubernetes/migrate-k8s.md Installs the Appsmith Helm chart using a specified values file. Ensure `values.yaml` is correctly configured for your environment. ```bash helm install appsmith appsmith/appsmith --values values.yaml ``` -------------------------------- ### Calendar Get Availability Items Examples Source: https://github.com/appsmithorg/appsmith-docs/blob/main/website/docs/connect-data/reference/google-calendar.md A list of calendars and/or groups to query for availability. Defaults to the user's default calendar if omitted. ```json [ {"id": "primary"}, {"id": "team@example.com"}, {"id": "conference-room-a@resource.calendar.google.com"} ] ``` ```json [{"id": "primary"}] ``` -------------------------------- ### Parent ID Example Source: https://github.com/appsmithorg/appsmith-docs/blob/main/website/docs/connect-data/reference/google-drive.md Example of a folder ID string used to specify a parent directory. ```text 1Ks8yUhqKNZ7z8g7GNqYt1_e9RUwhb6cQ ``` -------------------------------- ### Drive ID Example Source: https://github.com/appsmithorg/appsmith-docs/blob/main/website/docs/connect-data/reference/google-drive.md Example of a unique identifier for a shared drive. ```text 0AFEN07KuPJfUk9PVA ``` -------------------------------- ### Define Start Time Source: https://github.com/appsmithorg/appsmith-docs/blob/main/website/docs/connect-data/reference/google-calendar.md Sets the event start time using ISO 8601 or Unix timestamp formats. ```text 2025-06-15T09:00:00-07:00 ``` -------------------------------- ### API Endpoint Example Source: https://github.com/appsmithorg/appsmith-docs/blob/main/website/docs/packages/how-to-guides/create-js-module.md This is an example of an API endpoint URL used to fetch data. Ensure your endpoint is correctly configured. ```js https://api.baserow.io/api/database/rows/table/245748/?user_field_names=true ``` -------------------------------- ### Configure Pagination Start Index Source: https://github.com/appsmithorg/appsmith-docs/blob/main/website/docs/connect-data/reference/jira.md Set the starting record index for paginated results. ```text 20 ``` ```text {{ Input1.text }} ``` -------------------------------- ### Amplitude API Key Example Source: https://github.com/appsmithorg/appsmith-docs/blob/main/website/docs/connect-data/reference/amplitude.md This is an example of an Amplitude API key. This key is required for authentication when sending events. ```text abc123def456ghi789 ``` -------------------------------- ### Install helm-mapkubeapis Plugin Source: https://github.com/appsmithorg/appsmith-docs/blob/main/website/docs/help-and-support/troubleshooting-guide/deployment-error-guides/k8s-helm3.0.4-upgrade-error.md Install the `helm-mapkubeapis` plugin to help Helm manage API version changes during upgrades. This is the first step in resolving the upgrade issue. ```bash helm plugin install https://github.com/helm/helm-mapkubeapis ``` -------------------------------- ### Start local development server Source: https://github.com/appsmithorg/appsmith-docs/blob/main/README.md Launch the local development server to preview changes with live reloading. ```bash $ npm start ``` -------------------------------- ### Firestore Start After Pagination Example Source: https://github.com/appsmithorg/appsmith-docs/blob/main/website/docs/connect-data/reference/querying-firestore.md Use the last record from a previous query result as a starting cursor for pagination. This example shows how to reference the last item in a table or list data. ```javascript {{ user_Table.tableData[user_Table.tableData.length - 1] }} ``` ```javascript {{ users_List.data[users_List.data.length - 1] }} ``` -------------------------------- ### Deploy new Appsmith instance Source: https://github.com/appsmithorg/appsmith-docs/blob/main/website/docs/getting-started/setup/installation-guides/docker/migrate.md Initialize the new directory and start the Appsmith container. ```bash cd "$new_path" curl -L https://bit.ly/docker-compose-CE -o docker-compose.yml docker-compose up -d ``` -------------------------------- ### Serve local build Source: https://github.com/appsmithorg/appsmith-docs/blob/main/README.md Simulate the production environment locally to verify the generated build. ```bash $ npm run serve ``` -------------------------------- ### Create Release - Body Example Source: https://github.com/appsmithorg/appsmith-docs/blob/main/website/docs/connect-data/reference/github.md Provide release notes using GitHub Flavored Markdown to describe changes, new features, or breaking changes in the release. ```string ## What's New in v1.0.0 - Added new feature X - Improved performance of Y ## Breaking Changes - Function Z has been deprecated. ``` -------------------------------- ### CRM Search Object Pagination Example Source: https://github.com/appsmithorg/appsmith-docs/blob/main/website/docs/connect-data/reference/hubspot.md This example shows how to use the 'after' token for fetching the next page of data in a CRM search query. It utilizes a Jinja-like templating syntax. ```javascript {{ SearchObjectQuery.data.paging?.next.after || "" }} ``` -------------------------------- ### Create Keycloak Database Source: https://github.com/appsmithorg/appsmith-docs/blob/main/website/docs/getting-started/setup/installation-guides/azure/setup-to-integrate-sso.md Execute this command to initialize the database required for Keycloak. ```sql CREATE DATABASE keycloak; ``` -------------------------------- ### Product Metadata Example Source: https://github.com/appsmithorg/appsmith-docs/blob/main/website/docs/connect-data/reference/stripe.md Attach key-value pairs to a product for additional structured information. ```json { "category": "subscription", "internal_id": "PRO-2025", "feature_set": "complete" } ``` -------------------------------- ### Get Issue Type ID Example Source: https://github.com/appsmithorg/appsmith-docs/blob/main/website/docs/connect-data/reference/jira.md This example demonstrates how to dynamically fetch an issue type ID from a Select widget. This ID is required to fetch available operations for that issue type. ```javascript {{ selectIssueType.selectedOptionValue }} ``` -------------------------------- ### Example DSL Code for Git Commit Source: https://github.com/appsmithorg/appsmith-docs/blob/main/website/docs/advanced-concepts/version-control-with-git/reference/git-settings.md This example shows a snippet of DSL code that might be committed by Appsmith's auto-commit feature, highlighting version and widget properties. It's relevant when understanding what changes are automatically tracked. ```js //example dsl code "dsl": { "widgetName": "MainContainer", "parentRowSpace": 1, "type": "CANVAS_WIDGET", "canExtend": true, // highlight-next-line "version": 89, "minHeight": 1292, "parentColumnSpace": 1, }, ``` -------------------------------- ### Get Page ID Example Source: https://github.com/appsmithorg/appsmith-docs/blob/main/website/docs/connect-data/reference/notion.md Use this format to identify a page's unique identifier from its URL. ```string 7a774b5c39c942d4a640a9dc3a84f3f0 ``` -------------------------------- ### Insert a Heading at the Start of the Document Source: https://github.com/appsmithorg/appsmith-docs/blob/main/website/docs/connect-data/reference/google-docs.md Example of using the batchUpdate request to insert text at the beginning of a document. ```json [ { "insertText": { "location": { "index": 1 }, "text": "## Introduction\n" } } ] ``` -------------------------------- ### Initiate MongoDB Replica Set Source: https://github.com/appsmithorg/appsmith-docs/blob/main/website/docs/getting-started/setup/installation-guides/aws-ecs/set-up-high-availability.mdx Run this command as an admin user on your MongoDB instance to initialize the replica set configuration. ```bash rs.initiate() ``` -------------------------------- ### Confluence Custom Action Get Space Content Example Source: https://github.com/appsmithorg/appsmith-docs/blob/main/website/docs/connect-data/reference/confluence.md Example of a custom API query to retrieve all content within a specific space. Ensure you have the necessary permissions and refer to the Confluence REST API documentation. ```http GET /wiki/rest/api/space/{spaceKey}/content ``` -------------------------------- ### Define Migration Paths Source: https://github.com/appsmithorg/appsmith-docs/blob/main/website/docs/getting-started/setup/installation-guides/docker/migrate.md Set the environment variables for the old and new installation directories. ```bash old_path=~/appsmith-old new_path=~/appsmith-new ``` -------------------------------- ### Confluence Custom Action Get Content Properties Example Source: https://github.com/appsmithorg/appsmith-docs/blob/main/website/docs/connect-data/reference/confluence.md Example of a custom API query to retrieve content properties for a specific content ID. Refer to the Confluence REST API documentation for endpoint details. ```http GET /wiki/rest/api/content/{id}/property ``` -------------------------------- ### Display `appsmithctl` Help Information Source: https://github.com/appsmithorg/appsmith-docs/blob/main/website/docs/getting-started/setup/instance-management/appsmithctl.mdx Use the `--help` subcommand to view a list of all available subcommands and their options for the `appsmithctl` utility. This is useful for understanding the command's capabilities and syntax. ```bash appsmithctl --help ``` -------------------------------- ### Calendar Get Availability Time Max Example Source: https://github.com/appsmithorg/appsmith-docs/blob/main/website/docs/connect-data/reference/google-calendar.md Specifies the end of the availability interval in ISO 8601 format. ```text 2025-06-01T17:00:00-07:00 ``` -------------------------------- ### Prepare database restore directory Source: https://github.com/appsmithorg/appsmith-docs/blob/main/website/docs/getting-started/setup/installation-guides/docker/migrate.md Create the required directory structure for importing the database archive. ```bash mkdir -pv "$new_path"/stacks/data/restore ``` -------------------------------- ### Stripe Product ID Example Source: https://github.com/appsmithorg/appsmith-docs/blob/main/website/docs/connect-data/reference/stripe.md The unique identifier for a product in Stripe. Product IDs always start with 'prod_'. ```string prod_1a2b3c4d5e6f ``` -------------------------------- ### Trello Integration Guide Source: https://github.com/appsmithorg/appsmith-docs/blob/main/website/docs/connect-data/reference/trello.md Instructions on connecting to Trello and finding necessary IDs for API operations. ```APIDOC ## Connecting to Trello 1. Create a new Trello datasource in Appsmith. 2. Authorize Trello by logging in and granting Appsmith access. 3. Click the button to create a new API. ## Finding Trello IDs ### Exporting Board Data as JSON 1. Go to your Trello board. 2. Click the three dots (`...`) menu in the upper-right corner. 3. Select **Print, export, and share** > **Export as JSON**. 4. Open the JSON file and extract IDs for boards (`id`), organizations (`idOrganization`), cards (`cards.id`), labels (`labels.id`), lists (`lists.id`), members (`members.id`), and checklists (`checklists.id`). ### Exporting Card Data as JSON 1. Access the specific card. 2. Click the three-dots menu > **Share** > **Export JSON**. ### Using the API Developer ID Helper Power-Up 1. Install the [API Developer ID Helper Power-Up](https://trello.com/power-ups/646cc3622176aebf713bb7f8). 2. Add it to your board. 3. Follow the power-up's instructions to get Board, List, and Card IDs. ``` -------------------------------- ### Example Meeting Timezone Source: https://github.com/appsmithorg/appsmith-docs/blob/main/website/docs/connect-data/reference/zoom.md Specify the time zone for the meeting's start time using IANA timezone format. ```text America/New_York ``` -------------------------------- ### Mixpanel To Date Example Source: https://github.com/appsmithorg/appsmith-docs/blob/main/website/docs/connect-data/reference/mixpanel.md Specify the end date for the query in YYYY-MM-DD format. This is a required field and must be on or after the start date. ```text 2025-11-03 ``` -------------------------------- ### Describe Deployment and Verify Volumes Source: https://github.com/appsmithorg/appsmith-docs/blob/main/website/docs/getting-started/setup/installation-guides/kubernetes/migrate-non-ha-to-ha-helm.mdx Verify that the Appsmith deployment is mounting the new volume by describing the deployment. Replace `` and `` with your specific values. ```bash kubectl describe deployment/ -n ``` -------------------------------- ### Get Tasks with Page Pagination Source: https://github.com/appsmithorg/appsmith-docs/blob/main/website/docs/connect-data/reference/clickup.md Specify the page number for paginating through the task results. Pagination starts at page 0. ```javascript 0 ``` -------------------------------- ### Implement windowMessageListener Source: https://github.com/appsmithorg/appsmith-docs/blob/main/website/docs/reference/appsmith-framework/widget-actions/window-message-listener.md Example usage showing how to listen for messages from a specific domain and trigger an alert. ```javascript windowMessageListener( "https://your-site.github.io", (message) => { showAlert(message) } ) ``` -------------------------------- ### Retrieve Helm Values Source: https://github.com/appsmithorg/appsmith-docs/blob/main/website/docs/getting-started/setup/instance-configuration/configure-using-environment-variables.mdx Use this command to get the current Helm values for your Appsmith installation and save them to a `values.yaml` file for modification. ```bash helm get values appsmith -n appsmith -o yaml > values.yaml ``` -------------------------------- ### Navigate to website directory Source: https://github.com/appsmithorg/appsmith-docs/blob/main/README.md Change the current working directory to the website folder. ```bash $ cd website ``` -------------------------------- ### Confluence Pagination Parameters Example Source: https://github.com/appsmithorg/appsmith-docs/blob/main/website/docs/connect-data/reference/confluence.md Defines parameters for paginating search results, specifying the starting index and the limit per page. ```json { "start": 0, "limit": 25 } ``` -------------------------------- ### Keycloak Backup Export Log Output Source: https://github.com/appsmithorg/appsmith-docs/blob/main/website/docs/getting-started/setup/installation-guides/kubernetes/migrate-to-be-chart.md Example log output indicating the successful start and completion of the Keycloak data export process. ```log 07:25:11,805 INFO [org.hibernate.validator.internal.util.Version] (ServerService Thread Pool -- 57) HV000001: Hibernate Validator 6.0.22.Final 07:25:12,930 INFO [org.hibernate.hql.internal.QueryTranslatorFactoryInitiator] (ServerService Thread Pool -- 57) HHH000397: Using ASTQueryTranslatorFactory 07:25:13,691 INFO [org.keycloak.services] (ServerService Thread Pool -- 57) KC-SERVICES0033: Full model export requested 07:25:13,691 INFO [org.keycloak.exportimport.singlefile.SingleFileExportProvider] (ServerService Thread Pool -- 57) Exporting model into file /appsmith-stacks/data/keycloak_bkp/keycloak_backup.json 07:25:14,488 INFO [org.keycloak.services] (ServerService Thread Pool -- 57) KC-SERVICES0035: Export finished successfully ``` -------------------------------- ### Start Keycloak Backup Export Source: https://github.com/appsmithorg/appsmith-docs/blob/main/website/docs/getting-started/setup/installation-guides/kubernetes/migrate-to-be-chart.md Initiates a Keycloak data export to a single JSON file using standalone.sh with specific migration parameters. ```bash /bin/sh /opt/keycloak/bin/standalone.sh -c standalone.xml -b 0.0.0.0 -Djboss.socket.binding.port-offset=1 -Dkeycloak.migration.action=export -Dkeycloak.migration.provider=singleFile -Dkeycloak.migration.file=/tmp/keycloak_backup.json ``` -------------------------------- ### Example Updated Meeting Timezone Source: https://github.com/appsmithorg/appsmith-docs/blob/main/website/docs/connect-data/reference/zoom.md Specify the updated time zone for the meeting's start time using IANA timezone format. ```text Europe/London ``` -------------------------------- ### Create Release - Tag Name Examples Source: https://github.com/appsmithorg/appsmith-docs/blob/main/website/docs/connect-data/reference/github.md Specify the Git tag from which to create the release. Use standard versioning for major releases (e.g., 'v1.0.0') or pre-release identifiers for beta versions (e.g., 'v2.0.0-beta.1'). ```string v1.0.0 ``` ```string v2.0.0-beta.1 ``` -------------------------------- ### Migrate Configuration Files Source: https://github.com/appsmithorg/appsmith-docs/blob/main/website/docs/getting-started/setup/installation-guides/docker/migrate.md Create the new configuration directory and merge existing environment files into the new docker.env. ```bash mkdir -pv "$new_path"/stacks/configuration ``` ```bash cat "$old_path"/docker.env "$old_path"/encryption.env >> "$new_path"/stacks/configuration/docker.env ``` -------------------------------- ### Get Email by ID - Message ID Example Source: https://github.com/appsmithorg/appsmith-docs/blob/main/website/docs/connect-data/reference/gmail.md The unique identifier for an email message. Found in the URL when viewing an email in the Gmail web interface. ```url https://mail.google.com/mail/u/0/#inbox/**179f4e2e8d9f3a3b** ``` -------------------------------- ### Perform Custom API Actions Source: https://github.com/appsmithorg/appsmith-docs/blob/main/website/docs/connect-data/reference/asana.md Examples of direct API requests using the Custom Action feature. ```bash GET /v1/users?workspace={{workspaceSelect.selectedOptionValue}} ``` ```bash GET /v1/tasks/{{taskSelect.selectedOptionValue}}/stories ``` ```bash PUT /v1/tasks/{{taskSelect.selectedOptionValue}} ``` ```json { "custom_fields": { "1201234567890123": "High" } } ``` ```bash POST /v1/tasks/{{taskSelect.selectedOptionValue}}/addFollowers ``` ```json { "followers": ["1234567890123456"] } ``` -------------------------------- ### Get Meetings API Source: https://github.com/appsmithorg/appsmith-docs/blob/main/website/docs/connect-data/reference/zoom.md Retrieves a list of all scheduled meetings from your Zoom account. This endpoint returns meeting details such as IDs, topics, start times, and durations. ```APIDOC ## GET /meetings ### Description Retrieves a list of meetings from your Zoom account. This command returns meeting details including their IDs, topics, start times, and durations for all scheduled meetings. ### Method GET ### Endpoint /meetings ### Parameters No parameters are required for this command, as it retrieves all meetings for the authenticated user. ### Response #### Success Response (200) - **meetingId** (string) - The unique identifier of the meeting. - **topic** (string) - The topic of the meeting. - **startTime** (string) - The start time of the meeting. - **duration** (integer) - The duration of the meeting in minutes. - **joinUrl** (string) - The URL to join the meeting. - **creationTime** (string) - The time the meeting was created. - **settings** (object) - Settings related to the meeting (e.g., waiting room, registration). #### Response Example { "meetings": [ { "meetingId": "1234567890", "topic": "Project Kickoff", "startTime": "2023-10-27T10:00:00Z", "duration": 60, "joinUrl": "https://zoom.us/j/1234567890", "creationTime": "2023-10-20T09:00:00Z", "settings": { "waitingRoom": true, "registration": false } } ] } ``` -------------------------------- ### Initialize WebSocket connection Source: https://github.com/appsmithorg/appsmith-docs/blob/main/website/docs/build-apps/how-to-guides/set-up-websockets.md Create a function to establish the connection and handle the open event. ```js // Function to initialize the WebSocket connection initWebSocket() { // Create a new WebSocket instance this.socket = new WebSocket(this.socketURL); // Event handler for successful connection this.socket.onopen = () => { console.log('WebSocket connection established successfully'); }; ``` -------------------------------- ### Calendar Get Availability Time Zone Examples Source: https://github.com/appsmithorg/appsmith-docs/blob/main/website/docs/connect-data/reference/google-calendar.md Specifies the time zone for the response using IANA Time Zone Database names. Defaults to UTC if omitted. ```text America/Los_Angeles ``` ```text Europe/London ``` -------------------------------- ### Configure Basic Auth Header for OAuth 2.0 Source: https://github.com/appsmithorg/appsmith-docs/blob/main/website/docs/connect-data/reference/authenticated-api.md Example of the Authorization header format when using the Basic Auth scheme for client credentials. ```javascript Authorization: Basic bXlfY2xpZW50X2lkOm15X2NsaWVudF9zZWNyZXQ= ``` -------------------------------- ### Get Email by ID - User ID Example Source: https://github.com/appsmithorg/appsmith-docs/blob/main/website/docs/connect-data/reference/gmail.md Use 'me' for the authenticated user's Gmail ID. For delegated access, use the full email address of the account. ```email john.doe@example.com ``` -------------------------------- ### Start Docker containers Source: https://github.com/appsmithorg/appsmith-docs/blob/main/website/docs/connect-data/how-to-guides/how-to-work-with-local-apis-on-appsmith.mdx Commands to launch the Appsmith and Datasource services in detached mode. ```bash docker-compose up -d ``` ```bash docker-compose up -d ``` -------------------------------- ### Create Kubernetes Instance Backup Source: https://github.com/appsmithorg/appsmith-docs/blob/main/website/docs/getting-started/setup/instance-management/backup-and-restore/backup-instance.mdx Commands to identify the Appsmith pod, trigger the backup, and copy the archive to the local machine. ```bash kubectl get pods -n APPSMITH_NAMESPACE ``` ```bash # Replace `ANY_APPSMITH_POD_NAME` with your Appsmith pod name kubectl exec -it ANY_APPSMITH_POD_NAME -- appsmithctl backup ``` ```bash kubectl cp ANY_APPSMITH_POD_NAME:/appsmith-stacks/data/backup/APPSMITH_BACKUP_FILENAME -n APPSMITH_NAMESPACE LOCAL_BACKUP_FILENAME ``` -------------------------------- ### Switch to Staging Environment via URL Parameter Source: https://github.com/appsmithorg/appsmith-docs/blob/main/website/docs/connect-data/how-to-guides/setup-datasource-environments.md Append '?environment=staging' to your application URL to force the use of the Staging datasource environment. This is useful for testing staging configurations. ```javascript ?environment=staging // Example: https://app.example.com/app/customer-dashboard?environment=staging ``` -------------------------------- ### Describe Certificate for Troubleshooting Source: https://github.com/appsmithorg/appsmith-docs/blob/main/website/docs/getting-started/setup/installation-guides/kubernetes/publish-appsmith-online.mdx If the certificate is not ready, use this command to inspect its events and diagnose issues with cert-manager or the issuer. ```bash kubectl describe certificate appsmith-tls -n appsmith-ee ``` -------------------------------- ### Retrieve File ID Example Source: https://github.com/appsmithorg/appsmith-docs/blob/main/website/docs/connect-data/reference/google-drive.md Example of a Google Drive file identifier string. ```text 1BxiMVs0XRA5nFMdKvBdBZjgmUUqptlbs74OgvE2upms ``` -------------------------------- ### HubDB - Get Set Rows Source: https://github.com/appsmithorg/appsmith-docs/blob/main/website/docs/connect-data/reference/hubspot.md Gets a batch of specific rows from a HubDB table. ```APIDOC ## HubDB - Get Set Rows ### Description Gets a batch of specific rows from a HubDB table. ### Request Body - **Table ID or name** (string/number) - Required - The name of your HubDB table, or its numerical ID value. - **Inputs** (array) - Required - A JSON array with the IDs of the rows to get. ``` -------------------------------- ### Create Docker Instance Backup Source: https://github.com/appsmithorg/appsmith-docs/blob/main/website/docs/getting-started/setup/instance-management/backup-and-restore/backup-instance.mdx Commands to trigger a backup and copy the resulting archive from a Docker container to the host machine. ```bash docker-compose exec -it appsmith appsmithctl backup ``` ```bash docker cp appsmith:/appsmith-stacks/data/backup/appsmith-backup-DATE_AND_TIMESTAMP.tar.gz.enc . ``` -------------------------------- ### Switch to Production Environment via URL Parameter Source: https://github.com/appsmithorg/appsmith-docs/blob/main/website/docs/connect-data/how-to-guides/setup-datasource-environments.md Append '?environment=production' to your application URL to force the use of the Production datasource environment. This is useful for testing or viewing production data. ```javascript ?environment=production // Example: https://app.appsmith.com/app/customer-dashboard?environment=production ``` -------------------------------- ### Run Ansible Playbook for Appsmith Installation Source: https://github.com/appsmithorg/appsmith-docs/blob/main/website/docs/getting-started/setup/installation-guides/ansible.md Execute the Ansible playbook to install Appsmith. This command uses the inventory file and variables from appsmith-vars.yml. Ensure the install_dir in appsmith-vars.yml matches your Appsmith installation folder. ```bash ansible-playbook -i inventory appsmith-playbook.yml --extra-vars "@appsmith-vars.yml" ``` -------------------------------- ### Usage Example: Stop Auto-Refresh Source: https://github.com/appsmithorg/appsmith-docs/blob/main/website/docs/reference/appsmith-framework/widget-actions/clear-interval.md Example demonstrating how to use clearInterval() to stop an auto-refresh timer. ```APIDOC ## Usage Example: Stop Auto-Refresh ### Description This example shows how to stop an interval timer that is set up for auto-refreshing data. ### Code ```javascript clearInterval("autorefresh"); ``` ``` -------------------------------- ### Manage storage states Source: https://github.com/appsmithorg/appsmith-docs/blob/main/website/docs/reference/appsmith-framework/widget-actions/store-value.md Examples of persistent versus session-only storage using the persist argument. ```javascript {{storeValue('one',Input1.text)}} ``` ```javascript {{storeValue('two',Input2.text, false)}} ``` -------------------------------- ### Copy Backup to Local Disk Source: https://github.com/appsmithorg/appsmith-docs/blob/main/website/docs/getting-started/setup/installation-guides/kubernetes/migrate-to-helm-chart-v2-ce.md After creating the backup, use this command to copy the generated backup file from the pod to your local machine. Replace ``, ``, and `` with your specific values. ```bash kubectl cp /:/appsmith-stacks/data/backup/.tar.gz .tar.gz ``` -------------------------------- ### Export File ID Example Source: https://github.com/appsmithorg/appsmith-docs/blob/main/website/docs/connect-data/reference/google-drive.md Example of a Google Doc file identifier for export operations. ```text 1s3f4Lgpbhf6NzlMquqc-8dvK7WMbH ``` -------------------------------- ### Initialize Column Values Source: https://github.com/appsmithorg/appsmith-docs/blob/main/website/docs/connect-data/reference/monday.com.md Example JSON structure for initializing column data when creating or updating items in Monday.com. ```json { "status": "Done", "person": { "personsAndTeams": [ { "id": 12345678, "kind": "person" } ] } } ``` -------------------------------- ### Create Database Backup (Docker) Source: https://github.com/appsmithorg/appsmith-docs/blob/main/website/docs/getting-started/setup/instance-management/backup-and-restore/backup-database.mdx Execute the export_db command to generate a backup archive within the container. ```bash docker-compose exec -it appsmith appsmithctl export_db ``` -------------------------------- ### Filter Formula Example Source: https://github.com/appsmithorg/appsmith-docs/blob/main/website/docs/connect-data/reference/google-drive.md Example of a logical filter formula string used to refine search results. ```text var1 = "Project", var2 < "2023-12-31" ``` -------------------------------- ### navigateTo() Function Signature and Parameters Source: https://github.com/appsmithorg/appsmith-docs/blob/main/website/docs/reference/appsmith-framework/widget-actions/navigate-to.md Details on the navigateTo() function's signature, parameters, and how to use them for navigation and data passing. ```APIDOC ## navigateTo() ### Description Navigates to a specified page or URL within the application or to an external URL, with options to pass parameters and control the target window. ### Signature ```javascript navigateTo(pageNameOrUrl: string, params?: {}, target: "SAME_WINDOW" | "NEW_WINDOW"): Promise ``` ### Parameters #### pageNameOrUrl - **Type**: `string` - **Description**: The name of the internal app page or the external URL to navigate to. - For App Pages: `"NewPage"` - For External URLs: `"https://www.appsmith.com"` #### params - **Type**: `object` (optional) - **Description**: An object containing key-value pairs to pass as query parameters. These can be accessed on the destination page via `appsmith.URL.queryParams`. - Example: `{ "key": "value" }` #### target - **Type**: `string` (optional) - **Default**: `"SAME_WINDOW"` - **Description**: Specifies whether to open the navigation target in the `SAME_WINDOW` or a `NEW_WINDOW`. - Allowed values: `"SAME_WINDOW"`, `"NEW_WINDOW"` ### Usage Examples #### Navigating to an App Page ```javascript {{navigateTo('Dashboard', {}, 'SAME_WINDOW');}} ``` #### Navigating to an External URL ```javascript {{navigateTo('https://www.google.com', {}, 'NEW_WINDOW');}} ``` #### Navigating with Parameters ```javascript {{navigateTo('UserProfile', { userId: 123, status: 'active' }, 'SAME_WINDOW');}} ``` #### Conditional Navigation (within a Table widget's onClick event) ```javascript {{currentRow.status === 'pending' ? navigateTo('OrderDetailsPage', { orderId: currentRow.id }, 'SAME_WINDOW') : navigateTo('OrderHistoryPage', {}, 'SAME_WINDOW');}} ``` ### Response - **Type**: `Promise` - **Description**: Returns a Promise that resolves when the navigation is complete. ``` -------------------------------- ### Additional Fields JSON Example Source: https://github.com/appsmithorg/appsmith-docs/blob/main/website/docs/connect-data/reference/google-drive.md Example of a JSON object used to specify additional metadata fields in a response. ```json {"fields": "id, name, owners"} ``` -------------------------------- ### Install v3 Appsmith Helm Chart Source: https://github.com/appsmithorg/appsmith-docs/blob/main/website/docs/getting-started/setup/installation-guides/kubernetes/migrate-to-be-chart.md Execute these commands to add the Appsmith EE Helm repository, update your local repository cache, and then install the new v3 Helm chart. Ensure you replace `` with your target Kubernetes namespace and use your configured `values.yaml` file. ```bash helm repo add appsmith-ee https://helm-ee.appsmith.com helm repo update helm install appsmith appsmith-ee/appsmith-ee -n -f values.yaml ``` -------------------------------- ### Import cURL GET request Source: https://github.com/appsmithorg/appsmith-docs/blob/main/website/docs/connect-data/reference/curl-import.md Use this command to import a basic GET request into an Appsmith API datasource. ```bash curl -X GET https://example.com/resource ```