Skip to main content
hamburger menu
+ Create a topic

Lucid for Developers

Learn from and collaborate with other developers. Find answers to your most technical questions and get support with Lucid's APIs.

  • 261 Topics
  • 947 Replies
260 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

4883
Eric Padron
Lucid Legend Level 5
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

7417
Richard Udell
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!   

1590
S
A
afc
asked in Lucid for Developers
Data Linking Takes a Long Time to Reflect

I am currently developing an interactive diagram, which I have created an Appsheet which uses a Google Sheet. My dilemma is that Lucidchart takes a long time to reflect the changes made in the appsheet and in the Google Sheets. I have already set the auto refresh to 30seconds. Sometimes, to reflect the changes one of the users in the shared document has to refresh the data linking tab for it to show. Is there any way that I can solve this? Unfortunately, I cannot just utilize using Lucidchart only since there are a lot of formulas used which is convenient if the data passes through google sheets first. 

51
H
tobi
tobi
asked in Lucid for Developers
Get updates on document changes

Hey Hey I wonder if and how I can get a notification when a document is updated? Ideally programatically via a webhook. I found https://rollout.com/integration-guides/lucidchart/quick-guide-to-implementing-webhooks-in-lucidchart this but unfortunatley setup doesn’t work. (see error below): Thanks /Tobi ```{"code": "notFound","message": "Resource not found","requestId": "15f2b00fa5707d96","details": {"path": "/webhooks","method": "POST"}}``` 

273
Michael B
Y
Yun
asked in Lucid for Developers
No text when Import Mermaid flowchart to Google Doc

Hi, I have a mermaid flowchart in the lucid, but when import to the google doc, the text are missing. see the screenshots below.Also I’d like to have auto update when changing the mermaid code, like what https://mermaid.live/ does.  

335
Richard Udell
D
Dagon
asked in Lucid for Developers
Accessing a local extension in Lucidchart UI

I’m running a local extension as instructed in https://github.com/lucidsoftware/sample-lucid-extensions/tree/main/asana, and want to access it in Lucidchart UI. I have turned on Developer > Load Local Extension; and the code seems to run fine```$ node bin/dataconnectors/debug-server.js Routing /?kind=action (Import, Patch, HardRefresh)Listening on port 3001```But where do I find the extension in the Lucidspart UI so I can actually use it? I searched everywhere I can think of, and can’t find it :(

6315
Michael B
R
raffaele.schiavone
asked in Lucid for Developers
Organizational groups via API

I'm trying to create my organizational groups via API using the https://users.lucid.app/scim/v2/Groups endpoint and the urn:ietf:params:scim:schemas:core:2.0:Group schema, but the creation is only related to sharing groups, how can I create organizational groups via the same method? if not API is there a solution to create them massively somehow?

855
W
N
nathanlewan
asked in Lucid for Developers
Create new user with SCIM including shared group memberships

hello,I was attempting to use the SCIM to create users with one call to the SCIM, but have had no luck with passing shared group memberships as an attribute on the user creation call. The user gets created, but the shared groups I passed, are ignored.  Since the SCIM docs don’t show groups as part of the options for user creation, is it safe to assume it’s not possible, or am I doing something wrong?thanks!

443
W
D
dyashuni
asked in Lucid for Developers
How to create share link using API

I try to create a share link using the API curl --request POST \     --url https://api.lucid.co/documents/<MY DOC ID>/shares/shareLinks \     --header 'Lucid-Api-Version: 1' \     --header 'accept: application/json' \     --header 'authorization: Bearer <MY KEY>' \     --header 'content-type: application/json' \     --data '{  "role": "editandshare"}I get ​​​​​​​{  "code": "accessForbidden",  "message": "Access to this resource is forbidden",  "requestId": "eb1ab5121051b735"}I have Team plan. The document was created by me using API https://developer.lucid.co/reference/createorcopyorimportdocumentWhat is wrong with my request?

498
Michael B
D
dyashuni
asked in Lucid for Developers
Is there any way to download diagram as ".lucid" file

I want to correctly create .json files for importing into Lucidchart. The current number of examples in https://github.com/lucidsoftware/sample-lucid-rest-applications/tree/main/standard-import/demo-files is very limited and documentation at https://lucid.readme.io/docs/overview-si doesn’t cover a lot of cases.So I plan to download created by me diagrams as .lucid files and unzip them to extract the .json data.How do I get a lot of different examples of  .lucid files?

281
Richard Udell
C
Chris.Engstrom
asked in Lucid for Developers
ServiceNow Integration

After following the steps for integrating with ServiceNow: we get the following error: Error occured while creating Business Application Hierarchy in Lucidchart. Please try again.ServiceNow is describing the issue as a Token issue.Is anyone familiar with how to solve this?

39113
Ian Baenziger
A
akshayj
asked in Lucid for Developers
Draw Data Flow Diagram programatically

Hello,Is it possible to draw diagrams programmatically by importing data? For example, I could have data in an Excel/CSV or could import data via API. Then I would want to programmatically use the data and draw the diagram without having to create the diagram manually.  Is it possible to use Lucid Developers tools to achieve this? If yes, can you pls share some reference links and examples? 

322
A
F
Fernando Lins
asked in Lucid for Developers
Is it possible to import cards without a data connector?

As the title already mentions, I’m working on a POC following the instructions from this walk through:https://developer.lucid.co/docs/lucid-card-integrations But when it comes to the point of actually importing the cards, the articles creates a separate dataconnector to perform the import. More specifically in this part of the walk through:https://developer.lucid.co/docs/lucid-card-integrations#call-the-import-action Is it possible to implement the import function to just make an http call from the editorextension? Or it is a requirement to use a connector in between? If so, are there any examples available? Thanks.

241
Connor B
D
Darina Kasimova
asked in Lucid for Developers
Relationships between custom shapes

Hello, I'm creating a custom extension for Lucid and trying to find a solution for customizing relationships between custom shapes.I am thinking of Link points for custom shapes.Let's say when I start dragging a link from the Target shape, all the connection points or link points are removed from all the custom shapes on the page except the Source shape. So I can connect only these two shapes.Is it possible to dynamically change the connection points of a custom shape or remove them at all? And is there an event that listens to the start of dragging the link?I would appreciate any help and advise.

321
Connor B
T
Thierry Jousseaume
asked in Lucid for Developers
Erreur d'importation de Azure DevOps Work Item à partir de Lucidspark

BonjourJ’ai un problème dans Lucidspark quand je veux importer des Work Items ADOJ’ai un message d’erreur  Pourtant je suis bien connecté à mon compte ADO  J’ai suivi les conseils de la communauté pour vérifier mes paramètres mais je ne vois pas la rubrique « Cartes Lucid pour Azure DevOps » dans les paramètres de mon compte > Applications et intégrations > onglet Lucidspark > Cartes Lucid pour Azure DevOpsPouvez-vous m’aider ?Merci

152
T
M
MattP
asked in Lucid for Developers
After publishing - drag and drop, filters in smart containers etc

I have a specific usecase whereby we have a corporate license for Lucidchart, but we need our Operation to interact with Lucidcharts.We have built the chart, it uses a simple drag and drop interface and we’re using a container to allow for some filtering. Its for managing vehicles and what depot they are in.Its super simple and the Operation can use it with that limited functionality. Is there a way to publish this as an app? akin to Appsheet that anyone can use? or do they have to have a Lucidchart license and full access to LucidChart in which case it becomes non-viable as they’ll get overwhelmed by options!Thanks in advance.Matt

523
M
D
Darina Kasimova
asked in Lucid for Developers
Block adding custom shape data

Hello,I have a created a custom shape library with a set of properties for each shape. Through my custom extension I add additional properties to these shapes. It is possible to block adding custom data to custom shapes through Custom shape right-panel? So that I can only add properties via the custom extension.Thanks, Darina

594
D
A
arthurn
asked in Lucid for Developers
/documents API valid shape types

I am successfully using https://api.lucid.app/documents to create basic shapes using this json{  "version": 1,  "rules": [],  "collections": [],  "title": "TEST003",  "pages": [    {      "id": "page1",      "title": "page1",      "shapes": [        {"id":"block0","type":"database","customData":[],"boundingBox":{"x":100,"y":100,"w":100,"h":100},"text":"Block"}      ]    }  ]}but when I tried:{  "version": 1,  "rules": [],  "collections": [],  "title": "TEST003",  "pages": [    {      "id": "page1",      "title": "page1",      "shapes": [        {"id":"block0","type":"ArchiMate3ServiceBoxBlock","customData":[],"boundingBox":{"x":100,"y":100,"w":100,"h":100},"text":"Block"}      ]    }  ]}I got an error:"details":{"error":"Count: 1, message: Invalid shape type","import_error_code":"invalid_file"}}Is there a list of valid attributes? How do I make it working with ArchiMate3ServiceBoxBlock.ArchiMate3ServiceBoxBlock is a shape from standard shape library called “Enterprise Architecture”. 

122
Leianne C
Patrick Saul
Patrick SaulLucidite
posted in Lucid for Developers
Top Templates for Streamlining your Cloud Development Workflows

Why Visualize Cloud Development Workflows?Lucid’s suite is designed to support Cloud Development workflows end-to-end from concept to code through visualization and collaboration. By leveraging Lucid and visualizing more aspects of your Cloud workflow, you can expect to see:✅ Smoother handoffs and coordination between teams (product, design, engineering, devops, infrastructure, etc.) - Visualization reduces technical barriers to communication ✅ Fewer unplanned risks, dependencies, and blockers - better communication leads to better coordination & planning for upcoming software releases ✅ Greater speed to value on customer and business objectives - fewer blockers and dependencies leads to  software getting out the door fasterDid you know there are templates built into the product you can use to accelerate your workflow today? Here are a few of my favorites. Try them out, tweak them, and make them your own!Have another favorite? Post it in the comments!Customer Journey MappingThe tru

180
Patrick Saul
D
Darina Kasimova
asked in Lucid for Developers
Saving data to a file on a local laptop

Hello, I am currently facing a problem exporting some custom data to a file on my laptop.The data is properties from Custom data represented in Yaml format converted to a string. I’m trying to save it by clicking my extension in context MenuType created with client.registerAction.Normally, I use fs.writeFile on my server side and post method on my client side. Now I'm a little confused on how to do this with Lucid.I would appreciate any help.

253
D
K
kmizzi
asked in Lucid for Developers
Generate Flowchart using AI via API

Is there an API endpoint that allows us to send a prompt to generate a flow chart via AI?

273
Kelsey Gaag
L
lnguyenduc
asked in Lucid for Developers
Script that allows bulk conversion of draw.io diagrams into LucidChart diagrams

I'm trying to create a Python script that will download the drawio files in XML or drawio formats from a list of spaces that contain pages containing drawio macros and automatically upload them to LucidChart via its API. Once the files are converted, they will automatically have new IDs generated by Lucidchart that we will use in a mapping table that will be useful later. This mapping file is really important to know where to replace the old macros by the new ones. We will need the following columns: Space Key, Page Title, Page ID, Drawio file name.We will have to use this CSV mapping file, completed with the IDs of the new Lucidchart documents, to replace the old drawio macros with the new Lucidchart macros. (This is done using HTML tags.) This way, the new pages will be updated with the new Lucidchart files. I’m still struggling to get this mapping file from my script. Anyone could help me on this?

788
L
L
lnguyenduc
asked in Lucid for Developers
404 error when trying to import a drawio file to LucidChart via API

I try to use the import feature via API : https://lucid.readme.io/reference/createorcopyorimportdocumentBut I received this error message: {  "code": "operationRestricted",  "message": "You are restricted from performing this operation at this time",  "requestId": "c8ff1705c3bf7bb8",  "details": {    "reason": "Unable to create document from the provided template ID"  }}

436
Michael B
R
rmalick
asked in Lucid for Developers
Calculate the estimate of all shapes with a specific background color

Anyone know if there is a formula to calculate the Estimate value of all shapes where the background fill color is a specific Hex value?I’m still learning but here is what I have figured out so far...I have a container with 2 shapes inside it with different fill colors.I can calculate the number of shapes with a specific fill color using this formula=COUNTIF(children(page), x => FILLCOLOR(x)= HEXCOLOR('#e6e6ff'))Result of the above above is 1 since I have 1 shape that matches that hex value.And I can calculate the Estimate field using this formula:=CONTAINED."Estimate"The answer above is 5 (3 from one shape, and 2 from the other shape)But I want some way to calculate the estimate field of ONLY the shapes that have a fill color of “#e6e6ff”

172
R
Lucid Software Inc. Supplemental Community Terms

Get Started

Products

Solutions

Resources

Company

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