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.

  • 258 Topics
  • 915 Replies
258 Topics
Daniel H
Daniel H
posted in Lucid for Developers
End user process for adding custom UI apps?

I read the documentation on how to use React web framework to make custom UIs within LucidChart which can be found here: The documentation does a good job of explaining the development workflow.   Suppose I built a new react custom right panel.  How can I provide this custom right panel to all potential Lucidchart users? What is the process for end users to add custom apps?

120
J
Vyshnavy S
Vyshnavy S
asked in Lucid for Developers
Can you use Lucid chart api to export diagram in json or xml

Is it possible to export lucid chart diagram in xml or json format using Lucidchart export from third party system . I have an application which uses BPMN to map business processes I wanted to integrate Lucidchart as an option to import the BPMN I wanted to know if the LucidApis provide an option to export the diagrams from Lucid chart to third party in xml or json format. 

11283
Richard U
M V
M V
asked in Lucid for Developers
Create document contents via Rest API in Lucidchart

We are trying to create chart using API but we see only GetContents API only. Is there any POST API where we can create chart contents using the API.  

38012
Ian Baenziger
Iconduck
Iconduck
asked in Lucid for Developers
Having trouble with Parent/iframe Message Posting in Lucid

With respect to the Extension API calling `this.sendMessage` is not resulting in the iframe receiving the message. The code is being called from a class that extends `Panel`. The receiving iframe _does_ receive messages from the parent frame but not the ones I'm sending. Here's some of the `extension.ts` code: https://pastebin.com/LnTGjp9C The receiving frame's code is simple: window.addEventListener('message' function(event) {    console.log(arguments);}); Here's a screenshot of the events that _are_ captured (but not the one I'm sending from the parent):  https://s3.us-west-2.amazonaws.com/onassar.prod.02/screenshots/Screenshot%202023-08-28%20at%201.18.44%20PM.jpg

740
Iconduck
john.a.lopez
john.a.lopez
asked in Lucid for Developers
Automating API Calls with Lucidchart Formulas

First note the link to the forum:https://lucidchart.zendesk.com/hc/en-us/community/posts/17739799655316-Embed-Jupyter-Notebook-in-LucidChart-diagram-and-visa-versa?page=1#community_comment_18595071382932 The purpose of this is to drive automations that in turn return some value and thus influence the shape-object metadata and hence the conditional formatting. A use-case may be with a decision/gateway that collected data from previous task-properties via UPSTREAMDEEP. This is sent to the Python code that in turn evaluates the parameters makes a decision and returns that decision to the gatetway. This has numerous applications both in simulations and also in live-service at edge device status reporting. Please advise your thoughts. Thank you

863
Emma D
Richard U
Richard ULucid support team
posted in Lucid for Developers
Using the Lucid Extension API to fetch the URL response from a shape that "links to a web page"

@john.a.lopez  asked about enhancing the shape Actions > Link to Web feature by building an extension that fetches a response from a linked URL and then uses this response to populate a property value for a Lucidchart shape. That's a great question and I thought I'd move it here to the Lucid for Developers Community space for discussion on how this can be done!Can the URL set in an Action stored in the MapProxy.values and accessible via BlockProxy.allShapeData?A property named 'Link' is returned by block.properties.get('Link')  Does the URL need to be explicitly set as one of the shape's properties?No the user doesn't need to define the URL in the custom shape data. The URL will be stored in the block properties as 'Link'so long as it is assigned to the shape's with shape Actions > Link to Web feature. Finally once you have the URL then you can make a request to it using editorClient.xhr .or editorClient.oauthXhr to recover the response. For detailed documentation please refer to

370
Richard U
Richard U
Richard ULucid support team
posted in Lucid for Developers
Building dynamic shapes using formulas

Chris W. asked in our Product Questions Community space about building a custom server rack shape that can be resized by defining a property from the Contextual Panel > Layout > Advanced Options menu in the same way as our built-in server racks shapes library are sized based on the property "U". That's an excellent question and I thought I'd move it to the Lucid for Developers Community space for discussion!Resizing a shape based on a property value can be done with Lucid's Extension API!  However there are some limitations compared to the built-in library mainly the shape can only be resized by defining the property in the Advance Options panel.The trick is to set minSize and maxSize in the shape to have the same value for height and width where the height is calculated from the properties.For example if a property exists with the name U then the size constraints would be: "minSize": { "height": "=@U * 40" "width": 300 } "maxSize": { "height": "=@U

1360
Richard U
Kevin C101
Kevin C101
posted in Lucid for Developers
Can't access resource with the oauth2 token I c reated

I have successully followed the documentation to create my oath2 token but when I go to test it I get:         <h1>Not Found</h1>         <p id="detail">            For request 'GET /publicapi/oauth2/user'        </p> My command is: curl https://api.lucid.co/oauth2/user --request GET --header "Authorization: Bearer oauth2-<redacted token>" I have gone back to create my token a few times and tried a few different tests per the documentation.  I always get the above error back.   Thanks. Kevin J. Conway  

520
Richard U
Michael M101
Michael M101
posted in Lucid for Developers
VR/AR Future?

Developer question: Any VR plans? I had my first taste of VR/AR mind-mapping the other day and have since gone on to experiment with a few others including ShapesXR and Noda.  So this stuff is pretty cool and I can see a lot of advantage to moving to this type of interface.  Any Lucid plans to head this direction?

70
Richard U
Team F
Team F
asked in Lucid for Developers
Critical!: Incomplete data when getting the document content from the API

I think I have found a critical bug for API users when in my document I have a form of type "DefaultTableBlock" of a size other than 3 x 3 the document content request returns the figure trimmed to the first 9 cells ( 3 x 3) if the size is smaller the response JSON has empty cells in the same way if the size is larger I lose information. This is intermittent since if I modify the document moving the pages of the document or delete figures the request for the document content returns the information correctly however if I leave the document without modifying it for at least 5 minutes and return to run the request the error happens again. however in the diagram displayed in Lucidchart there is no loss of information or any visible errors. At the moment as far as I've tested this only affects "DefaultTableBlock" figures is it a bug? Example with bug: { "id": "8~wjFQtBQs06" "class": "DefaultTableBlock" "textAreas": [ { "label": "Cell_00"

320
Team F
Laszlo P
Laszlo P
asked in Lucid for Developers
Embedd Lucidchart viewer without scrolling feature

The embedded Lucid chart is displayed in a viewer where the user can scroll the chart even if the entire chart fits the window. It is very easy to accidentally scroll the chart out of view in the viewer. Is there a simple embedded viewer option where the chart is fixed in the viewer? 

3456
S
Laszlo P
Laszlo P
asked in Lucid for Developers
Embedded Lucid Chart automatic data refresh

I have created a Lucid Chart with data link to a Google Sheet. I have embedded the chart in my custom web application. When I make a change in the Google Sheet most of the time (not always) within 30 seconds the change is reflected in the Lucid Chart editor. To see the data changes in the embedded chart on my web site I have to open the chart in the Lucid Chart editor where most of the time it automatically refreshes. Is there a way to force the embedded chart data refresh when I reload the page of my custom web application without opening the chart in the Lucid Editor? It would be great to be able to periodically call a URL with a background process to force the Lucid Chart data update so the embedded chart would show the latest on the web site.

1529
Micah
Boris N
Boris N
posted in Lucid for Developers
Lucidchart API - list of folders IDs

Hi LucidchartsWhat is the preferred API method to get a list of folders IDs? I'm trying to pull together the list of users and collaborators and all of those calls require a folder ID; but I'm finding difficulty even fetching a list of folder IDs. Is there an API call to GET /folders which returns a list of folder IDs? Thank you -Boris

1570
Boris N
Ben F101
Ben F101
posted in Lucid for Developers
Get Lucidchart comments via API

Is it possible to get all the comments in a document via the API? Further can it be filtered by comment date? The use-case is to get comments for any changes since the last application release. The engineering team would update the diagram if/when something changes for the release.

190
Richard U
Boris N
Boris N
posted in Lucid for Developers
Lucidchart user token API

Hi I'm managing an organization of less than 100 users in a non-Premium account. I was trying to use the API to ease onboarding and manage folders and group structures and stumbled upon a roadblock. I created an App Integration with scopes: readonly+offline_access+account.user and was able to query the API successfully. For selective calls such as list-folder-user-collaborators: https://developer.lucid.co/rest-api/v1/#list-folder-user-collaborators the API calls fail with a 403. {  code: 'userOperationOnly'  message: 'Only users can perform this operation'  requestId: '866a9e8bfe19e3c0'} I'm not sure how to get a user token and I have the following questions.1. How do I get / generate a User Token? Are "team-admins" allowed to generate this token or is the "account-owner" the only one allowed to do so? 2. Is this accessible without a Premium Account?   Thank you. -Boris

4190
Boris N
David E
David E
posted in Lucid for Developers
OAuth with Azure AD - Error

I am working on a Lucid extension and I have configured an oauth provider in the extension's manifest file. The OAuth provider is Microsoft Azure AD. When I make an API call using client.oauthXhr I get redirected to the Microsoft login page where I provide my credentials which then redirects me to the redirection url for my extension. However I then get an error 500 with the following message: This exception has been logged with id 81k4n3m13. Any ideas? I have successfully setup a Google oauth provider as described in the Lucid API guide but I need it to work for Azure AD. Thanks.

410
David E
Mike K101
Mike K101
posted in Lucid for Developers
Active status of user. Why we are not getting this through API?

Hi everyone I was able to get the Lucidchart API to work to get the information of a user but when I checked the response it does not give us the active/inactive status of the user. But I can see that on Lucidchart console. Is their any other API that I am missing if yes please help me with the same.

220
Michael B
Denis B
Denis B
posted in Lucid for Developers
How to declare data scheme with object with array of custom objects in it?

I want to implement my dataConnector and post some custom data(like object with array of object as a field in it):  class MyClass {     id:number;     name:string;     subItems: SubItem[] }  class SubItem {    id:number;     name:string;  }   Maybe you have some examples how to do this because some examples from documentation I guess are out of date.

340
ablackburn
Robert M101
Robert M101
posted in Lucid for Developers
UI Design Tool

I am looking for a UI Design tool to begin building the next part of my project.   This will be a mock-up for a user interface for a game I am building

220
Richard U
Sebastian S
Sebastian S
asked in Lucid for Developers
Generate an Access OAuth2 Token Without Invalidating the Refresh Token

I am trying to use Singer and Meltano—external ELT tools—to create an integration with LucidChart's API. This integration would allow for data to be pulled from a user's LucidChart account to populate a database or other storage medium. However I am running into an issue with the way LucidChart handles refresh tokens. As I understand it when I use the offline_access scope to have the user generate a refresh token I can then use this refresh token to request an access token any time within the next six months. However when I do so I also generate a new refresh token and invalidate the previous one. This makes my use case very difficult as I might potentially have multiple processes running at once attempting to use the LucidChart API. Awkward race conditions occur where one process attempts to use a refresh token that has been invalidated by another process. Is there any way around this difficulty? Is there any way to generate an access token without invalidating the refresh token that

2651
Michael B
Richard U
Richard ULucid support team
published in Lucid for Developers
Creating custom shape libraries using the Lucid API

Hello there!We’re excited to show you how to transform a folder of image files into a Lucidchart shape library. This will bring a new level of customization to your Lucid documents and can be done in less than ten minutes.  When you complete the instructions you’ll have an extension package (basically a folder with a bunch of formatted files). The next section in this guide describes how to distribute this extension package (e.g. actually make it usable in Lucid for the users you want). Before you begin you’ll need node.js installed to download the Lucid SDK. As described in the Extension API documentation the CLI command to download the Lucid SDK is npm install lucid-package.  If you’ve already installed the Lucid SDK you will need to update it to at least version 0.0.58 which was released on March 29 2023. You can see what version you have by using the npm status command. Updating NPM packages can typically be done by using the npm update command. Currently only JPG PNG and SVG files

3810
Richard U
Aviv D
Aviv D
asked in Lucid for Developers
Lucidchart api token through POSTMAN

Hi All  I'm trying to generate a code via POSTMAN to generate an API token but I'm receiving a connecting error after the pop-up login page.When I'm doing it manually through the browser I'm able to get the code but I can't make it automatically.Is the code something temporary just for the first token generation or I will have to generate a new code every one or two hours?Does anyone have any experience with that and can assist here? Thanks!

3353
Michael B
clund
clund
posted in Lucid for Developers
Asana Integration with LucidChart

I'm considering linking / integrating our LucidChart into our Asana software. I read all your info on integration but what I don't seem to see is if this will give everyone access to change my LucidChart document. I definitely don't want to lose control of the document - we want limited access to change it - but I'd like our community within Asana to be able to access it and possibly print it. Can someone help here? Thank you Cindy

360
Ian Baenziger
Smitha M
Smitha M
asked in Lucid for Developers
Invalid scopes: account.user+offline_access

I'm trying to generate ACCESS TOKEN with  account.user+offline_access scope and I keep getting Invalid scope error. Is there a differnt way to specify multiple scopes ? Invalid scopes: account.user+offline_access  

1556
Michael B
Kari.Mortensen
Kari.Mortensen
posted in Lucid for Developers
Group creation API?

I was looking through the API documentation for LucidChart and I see a get group create group collaborator and delete group collaborator. But what I really want is to create a Group with an API call.  Here's the manual way:https://help.lucid.co/hc/en-us/articles/360049892711-The-Admin-Panel-Group-Management 

210
Michael B
Lucid Software Inc. Supplemental Community Terms

Get Started

Products

Solutions

Resources

Company

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