Skip to main content
hamburger menu
+ Create a topic

Use Cases

Discuss real-world applications, success stories, and best practices for leveraging Lucid products across various industries and scenarios.

361 Topics
S
Scott PLucidite
posted in Lucid for Developers
🚀 Announcing Editable Embeds on Lucid's API!

Hey Lucid Devs! 👋We’re excited to introduce Editable Embeds—a new way to integrate Lucid documents directly into your web applications! 📝 Now you can embed Lucid documents that are not just viewable but fully editable with our token-based embed solution, allowing for seamless collaboration right within your own platform. Why Editable Embeds?By embedding the Lucid experience in other apps, you can improve documentation and minimize the need to switch between apps. With Editable Embeds, you can:Enable users to edit and collaborate on Lucid documents directly within your app. Streamline development and testing with an easy-to-use embedding process. Add comprehensive diagramming and collaboration tools to your application. 🛠 How to Get StartedPut simply, here’s the setup: create an application > obtain an access token > generate an embed session token > embed the viewer in your app > configure “editable” access level. See the details (and example implementations!) in our Tok

3992
Humas1985
Lucid Legend Level 8
S
Scott PLucidite
posted in Lucid for Developers
🚀 Announcing New API Keys available on Lucid’s API!

Hey Lucid Devs! 👋We’re excited to introduce a new way to securely access the Lucid API using API Keys! 🔑  Even seasoned engineers sometimes find OAuth2 complex and time-consuming—it can take hours to set up properly. With API Keys, the process is far more straightforward. Simply generate an API Key in the Dev Portal and include it in your API requests!🛠 How to Get StartedCheck out our API Keys Guide!🔒 Are there Admin Controls?Yes, Admins can choose to enable/disable API Keys. Apps with API Keys will only be accessible from the Developer Portal by the App creator and any Lucid Developer added as a collaborator to the app. See our App Collaborator roles guide for more information.  🚨 Important NotesTreat your API Keys like passwords. Do not expose them in your client-side code or share them publicly.  Regularly review and rotate your API Keys to maintain security. Generally, an API Key can be used in place of an OAuth 2.0 User token, however certain endpoints– such as the Document S

5947
Richard U
S
Scott PLucidite
posted in Lucid for Developers
Recent webinar recording: See firsthand how easy it is to build in Lucid

Curious to see what’s possible for your org to build through the Lucid developer platform?In our most recent webinar, our developers demonstrated how easy it is to build an extension on Lucid’s developer platform by building one in real time.During the webinar, you’ll also see the types of integrations you can build on the developer platform as well as open-source examples to use as starting points in your own projects. Here is a link to the recording: How to build an extension on Lucid’s developer platformRecorded on May 30, 2024 You can also check out the demo integration for yourself on Lucid's integration marketplace and an accompanying guide in our developer documentation. We’d love to hear what you’re building and are happy to answer any questions you have about our demo. Drop a comment below!   

1370
S
Michel L
Michel L
asked in Lucid for Developers
Search account document problem

I’m trying to create a data connector for getting the documents associated to an account using this endpoint:https://api.lucid.co/accounts/me/documents/searchBut I get a 403 error, so the performDataAction is not fired. Please, what could be wrong?Extension registered action code: client.registerAction("getAccountDocumentlist", async () => { const triggerOauth = await client.oauthXhr("lucid", { url: "https://api.lucid.co/accounts/me/documents/search", headers: { "Lucid-Api-Version": "1", "Content-Type": "application/json", }, data: "{}", method: "POST", }); console.log("triggerOauth", triggerOauth); const result = await client.performDataAction({ dataConnectorName: "dataconnector", actionName: "GetAccountDocumentList", actionData: { message: "GetAccountDocuments" }, asynchronous: true, }); console.log(result); }); -manifest.json  content:... "oauthProviders": [ { "name": "lucid", "title": "Luci

161
A
bnomichith
bnomichithLucidite
posted in Inspiration
[Upcoming webinar on February 27] How non-technical teams use Lucid: New examples to inspire your work

I’ve got exciting news for all the great humans here in marketing, operations, sales, strategy, finance, and other non-technical roles! We’ll be revisiting one of our most popular webinar topics with three all-new examples of how non-technical teams use Lucid to work more efficiently. Here are the details:How non-technical teams use Lucid: New examples to inspire your workFebruary 27, 2025 at 11 a.m. MTJoin us for tips, demos, and templates on using Lucid to: Brainstorm, prioritize, and plan impactful projects.  Visualize, document, and improve processes.  Transform dull meetings into lively, actionable sessions.Register here: https://lucid.co/resources/webinars/how-non-technical-teams-use-lucid-feb-2025?utm_medium=lucid-outreach&utm_source=community&utm_campaign=webinar&utm_content=feb-2025-gtm-webinar3  

170
bnomichith
Michel L
Michel L
asked in Lucid for Developers
Usage of Key for updating a datasource in a connector

I am surprised about how you need to set the patch items of an update for making the update runs without error.I write a dataconnector for retrieving document list and  Initially I used this code for the key to the patch without success:itemsPatch.set( apiDocument.documentId, convertToDocument(apiDocument as ApiDocument), )Full code:export const getDocumentListAction = async (action: DataConnectorAsynchronousAction) => { const apiDocuments = await searchDocuments(action.context.userCredential); const itemsPatch = new Map<string, SerializedFields>(); var i = 0; apiDocuments?.forEach((apiDocument) => { itemsPatch.set( apiDocument.documentId, convertToDocument(apiDocument as ApiDocument), ); }); if (apiDocuments) { action.client .update({ dataSourceName: "Lucid", collections: { "Lucid Documents": { patch: { items: itemsPatch, }, schema: documentSchema, }, },

242
Michel L
Richard U
Richard ULucid support team
posted in Lucid for Developers
FIXED: API Documentation Temporarily Down

✅ Edit: This issue has been fixed. ✅Hey Lucid Developers,Our API documentation at developer.lucid.co is currently unavailable due to a ReadMe outage. Since our documentation is hosted on ReadMe, we’re unable to resolve this directly but are monitoring the situation.You can track updates on ReadMe’s status page here: https://www.readmestatus.com/We're expecting the documentation to be back up by the end of the day. Thanks for your patience, and we’re here to help—drop any questions below!Apologies for the inconvenience.

161
Sylvia X
J
johnktejik
asked in Lucid for Developers
invalidImportType error

I’m trying to create a new document in lucidchart by importing a .lucid file.  I am using the demo.lucid file.  I have also tried creating my own .lucid file.  I cannot figure out what I am doing wrong.  Everything seems to match the instructions at https://lucid.readme.io/reference/createorcopyorimportdocument The error :    "code": "invalidImportType",    "message": "Importing the provided file type is not supported"Here is my Curl:curl --location 'https://api.lucid.co/documents' \--header 'authorization: Bearer oauth2-...8sKF' \--header 'lucid-api-version: 1' \--form 'product="lucidchart"' \--form 'title="helloform"' \--form '=@"/C:/Users/USER/Downloads/demo (1).lucid"'Here is a screenshot Any advice is appreciated

213
J
J
johnktejik
asked in Lucid for Developers
api creates document but no shapes

First time user here.  I’m just trying to get a basic api call to create a shape for me.  A ‘hello world’, so to speak.What I have done:1. Created document.json2. Zipped it into a file.3. Referenced file in Postman API requestDocument is created in lucidchart, but there is nothing in it.here is my document.json: {   "version":1,          "title": "Hello World",          "product": "lucidchart",          "pages": [            {              "id": "page1",              "title": "Main page",              "shapes": [                {                  "id":"shape1",                 "type":"rectangle",                 "text":"hello",                 "boundingBox":{                    "x": 50,                    "y": 30,                    "w": 100,                    "h": 150                  }                }                          ]              }          ]        }Here is my postman request:{  "title": "stupid helloworld",  "product": "lucidchart",  "file":"C:/Users/KTE2922/Downloads/

354
Michael B
Kelsey Gaag
Kelsey GaagLucid community team
published in Inspiration
Tips for facilitating meetings in Lucidspark 💻

Want to run more efficient and engaging meetings? Try these facilitation tips in Lucidspark to keep your team aligned and productive—whether you’re meeting in person, remotely, or in a hybrid setting. Utilize paths and frames for seamless topic transitionsFrames and paths help you effortlessly manage the flow of your meetings. Instead of constantly scrolling and zooming to navigate your boards, you can seamlessly open a path and click through to transition to different topics. Additionally, you can link to the path, which allows everyone in the meeting to follow the same path and easily navigate through the board. This prevents confusion and keeps your team on topic.   Add quick tools for efficiency Make collaboration easier by leveraging Quick Tools, which allows you to drag frequently used elements—like sticky notes, Lucid Cards, and story points—directly onto your canvas. This feature allows contributors to easily navigate and add to the canvas. This is a great tool for newer users

40
Kelsey Gaag
Michel L
Michel L
asked in Lucid for Developers
Rest API inconsistency with documentation

According to the documentation, “https://api.lucid.co/documents/search” endpoint gives the result:  "documentId": "110808fd-4553-4316-bccf-4f25ff59a532",  "title": "document title",  "editUrl": "https://lucid.app/lucidchart/110808fd-4553-4316-bccf-4f25ff59a532/edit",  "viewUrl": "https://lucid.app/lucidchart/110808fd-4553-4316-bccf-4f25ff59a532/view",  "version": 101,  "pageCount": 5,  "canEdit": false,  "created": "2019-04-22T13:47:23Z",  "creatorId": 12345,  "lastModified": "2020-06-26T16:29:37Z",  "lastModifiedUserId": 54321,  "customAttributes": [],  "customTags": [    "in progress"  ],  "product": "lucidchart",  "status": "Complete",  "classification": "Private",  "trashed": null,  "parent": null,  "owner": {    "id": 123456,    "type": "user",    "name": "John Doe"  }especially tells that there is a response field “owner” which is good.But unfortunately in the real world the result is :documentId: 'efde95db-0d4e-4173-a6a4-c49fac4cc046',    title: 'Sample Diagram 19',    editUrl:

142
Michel L
Michel L
Michel L
asked in Lucid for Developers
Creating a dataconnector - how to define an array

Creating a dataconnector for retrieving document list, the only way I found is to define an array is to use a declaration field as any:... { name: "customAttributes", type: ScalarFieldTypeEnum.ANY, }, { name: "customTags", type: ScalarFieldTypeEnum.ANY, },which  IMHO is not good I would like to use things like  { name: "customAttributes", type: []ScalarFieldTypeEnum.STRING, }, { name: "customTags", type: []ScalarFieldTypeEnum.STRING, },Any suggestions?Best regards. 

132
Michel L
B
Brock WoodLucid product team
posted in Inspiration
🔍 Search for Lucid documents using your browser search bar 🔍

We are excited to announce site search functionality! This allows for browser-native searches for Lucid documents directly from your search bar! If you are already signed in, this will take you directly to the search results page for your query. To learn more about how you can set this up for your web browser you can reference the PDF attached to this post.  

645
Humas1985
Lucid Legend Level 8
shannon
shannonLucidite
posted in Inspiration
Webinar follow-up questions and resources: Stay in sync with Jira and ADO integrations

Thank you for joining us for our webinar, “Stay in sync with Lucid’s Jira and Azure DevOps integrations”! (If you didn’t have the chance to join, you can access the webinar on demand here.)Check out these additional resources!Jira and Azure DevOps integrations:Integrate Lucid Cards with Jira Integrate Lucid Cards with Azure DevOps Cloud Video: Lucid Cards for Jira Video: Lucid Cards for Azure DevOps Blog post: Make the most out of the Lucid Cards for Jira integrationOther capabilities:Task estimation Dynamic Table Visual Activities Progress bars and workload trackers Template: Measure confidence activity An Agile team’s guide to sprint planning in LucidAgile event templates that incorporate Jira/ADO integrations:Backlog refinement Sprint planning Big room planningOur Jira and Azure DevOps integrations are available to Enterprise users. If you’re not currently on an Enterprise account, reach out to our team to learn more.Leave any follow-up questions you have from the webinar in the com

973
Ria S
Lucid Legend Level 7
Michel L
Michel L
asked in Lucid for Developers
Retrieve Size of Document using Rest API

Hello Guys,Is there a way to retrieve the size of a document using Rest API.The size is currently available manually from the “Details” panel windows displayed using “Show Detail” context menu command on a document.Best regards.

425
A
Q
quodsimDan
asked in Lucid for Developers
How to Delete a DataSource or Collection?

If my extension editor has create a DataSource, is there a way for it to delete it as well? Here is the documentation URLs that I looked for a delete method in:https://developer.lucid.co/reference/dataproxy-sdk https://developer.lucid.co/reference/datasourceproxy-sdk https://developer.lucid.co/reference/collectionproxy-sdk https://developer.lucid.co/reference/dataitemproxy-sdkThanks,Dan

291
Connor B
J
johnktejik
asked in Lucid for Developers
My first API call - all keys are 'view only' - 403 response

I have followed the instructions herehttps://lucid.readme.io/reference/obtaining-an-access-tokenand herehttps://lucid.readme.io/docs/api-keys but it is not working.  I keep geting a 403 unauthorized error.  There is also something on the apikey page saying ‘view only’.  This ‘view only’ is not mentioned in any instructions.  I have tried searching for this ‘view only’ issue but have not found any matches.  Ps. I can read using the API, but cannot write/create.Anyone have any ideas?  

368
J
D
Dominik Badger
asked in Lucid for Developers
Minimize Logins and keep Lucidchart sessions alive longer

Any chance to keep Lucidchart sessions alive longer?Whenever I open a new window I need to log on again. Would be great to skip that process and save time.

173
Shira M
Lucid Legend Level 3
S
ShannonMGO
posted in Inspiration
Which template for visualizing nonprofit donors?

Hi friends,I work as a major gifts fundraiser for a nonprofit and manage a portfolio of about 150 donors. I’ve got them all in a database, as well as a spreadsheet, but I need to be able to visualize and organize them in various groupings based on a few different datapoints. I’m not sure which template I should use but I’d love ideas from this community. Here are the details of what I need:Visually organize and color-code donors based on:  Geographic location Interests in different areas of the nonprofit’s programmatic work. They may have one singular interest or may have multiple interests.  3 levels of engagement: A, B, and C I’d like to be able to drag and drop or easily change color/shape if a donor moved from Boston to Atlanta, for example. I’d also be able to switch views so I can see, for example, all donors with interest in education, or all A-level donors, or all Massachusetts donors. If at all possible to assign tasks/set reminders for actions within this visual chart, tha

111
Shira M
Lucid Legend Level 3
R
Ricardo Uribe
asked in Lucid for Developers
Error "An unknown error occurred" call API Lucid GET/documents/{docID}/contents

Hola comunidad, actualmente estoy llamando a la API /documents/{docId}/contents para obtener los Metadatos del documento y utilizarlos en un desarrollo de mi empresa. Muchos de los documentos dan 200, pero hay algunos que me dan un error 500 con el mensaje "An unknown error occurred", lo extraño es que si hago una copia de este documento, sin cambiar su contenido, con el nuevo id del documento, funciona normalmente. Entonces mis preguntas son: ¿Cuáles son las razones por las cuales puede ocurrir este error? y ¿Si puedo mitigarlo de alguna manera?  y ¿Por qué no se detalla este error en la documentación? 

232
A
D
dude95
asked in Lucid for Developers
Struggling with import API - Document Created but no shapes

Really struggling with the import API.  I’m getting the oAuth2 tokens successfully, able to create documents just fine, but they don’t have anything in them even though i’m sending off json for creation.  Trying to mimic the jira to Lucid as closely as possible, but it’s not working out.  Logs indicate success, but that’s because the documents are getting created.My log:Create Document Response: {  documentId: '369afc52-f1f2-41ee-be08-fd63581fe00f',  title: 'Updated Test Document with Shapes',  editUrl: 'https://lucid.app/lucidchart/xxxxx/edit',  viewUrl: 'https://lucid.app/lucidchart/xxxxx/view',  version: 110,  pageCount: 1,  canEdit: true,  creatorId: 136597754,  lastModified: '2024-09-23T14:50:45Z',  lastModifiedUserId: 136597754,  trashed: null,  status: 'Draft',  classification: null,  customAttributes: [],  customTags: [],  parent: 383364222,  product: 'lucidchart',  created: '2024-09-23T14:50:45Z'}  // Define the shapes using the structure from the example const documentD

755
D
N
nikolai
asked in Lucid for Developers
Programmatically create shapes and lines using REST API?

Hello Lucidchart Developer Community,I'm currently exploring the functionalities of the Lucidchart API and I've hit a roadblock. My project requires dynamic creation and manipulation of diagram elements, specifically shapes and lines, and I'm curious about the extent of Lucidchart's API capabilities in this regard.Does Lucidchart offer a REST API that allows for the programmatic creation of shapes and lines within a diagram? I'm interested in understanding how detailed this control is, such as specifying types, sizes, positions, and custom styling for these elements. Additionally, how feasible is it to dynamically add, modify, or interconnect these elements within a Lucidchart document via automated processes or external applications?Any insights, documentation references, or examples of similar implementations would be greatly appreciated. Looking forward to your responses and guidance!Best regards,Nikolai

3686
J
R
Rajath
asked in Lucid for Developers
Latest Version of Mermaid in Lucidchart

Can the latest version of mermaid be supported in Lucidchart? With the current supported version, I am getting a few syntax error while testing out the default syntax from mermaid website.  Once the flowcharts have been created using the code, can we have the following features? Conditional formatting to update the block, line (arrow) and text color, size, font style. Provide an option to copy the generated flow into a new image so that conditional formatting can be applied as needed.

90
R
Q
quodsimDan
asked in Lucid for Developers
DocumentId of running Poll and HardRefresh Data Connector Action

Lucid,I have setup both the Poll and HardRefresh actions for my LucidChart extension package.  Is there a way to programmatically get the documentId within a Poll or HardRefresh?Here is the documentation for DataConnectorActionContext:https://lucid.readme.io/reference/dataconnectoractioncontext-sdkThanks,Dan

284
Connor B
Q
quodsimDan
asked in Lucid for Developers
Access the DataProxy within DataConnectorAsynchronousAction?

 My extension editor has defined a data source which contains multiple collections of data items.I have an Data Connector Action defined that gets triggered when a user hits a button in the extension editor.I know in the extension editor project, I have access to a DataProxy, which has access to DataSources and CollectionProxy, etc. Through the DataProxy, I am able to access all the custom data found in the document correct?Assuming that is true, in a Data Connector project, such as in an action: DataConnectorAsynchronousAction, is it similarly possible to access all the custom data found in the document?  If so, how?  I am not seeing how I can access the DataProxy within DataConnectorAsynchronousAction. Thanks,Dan 

394
Connor B
Lucid Software Inc. Supplemental Community Terms

Get Started

Products

Solutions

Resources

Company

Privacy Legal Cookie privacy choices Cookie policy
©   2024  Lucid Software Inc.