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.

  • 90 Topics
  • 309 Replies

90 Topics

S
Scott PLucidite
posted in Lucid for Developers

New Share Link APIs

Hello, Lucid Developers Community! We're happy to announce the launch of our brand-new Share Link APIs, a step forward in enhancing collaboration and sharing capabilities within your applications. What's new with Share Link APIs? Using these APIs, users can automatically generate share links for their documents, making it much easier to share and distribute these documents with others on their team. Streamlined Collaboration Generate and manage shareable links directly from your app Easy Integration A simple API call integrated directly into your workflows is all it takes to create/delete shareable links and update link settings Enhanced Security Control (Enterprise accounts only) Add passcodes Set expiry dates Restrict shareable links to account-only users with the restrictToAccount property Enable Guest Collaboration in your shareable links for Lucidspark Custom Access Levels Decide exactly how others can interact with your shared documents – view, edit, or comment  For a deep

1
Ria S
Lucid Legend Level 1
1 month ago
Sylvia X
Sylvia XLucid support team
posted in Lucid for Developers

Lucid Standard Import (a.k.a. JSON Import) API FAQ

Hi Lucid Developers! 👋Since the launch of our JSON Import functionality, we've seen an array of creative and efficient uses by our customers. In this post, we'll address some of the most frequently asked questions about the JSON Import feature. Additionally, we’d like to announce expanded functionality based on your valuable feedback: support for adding notes to shapes via the API! 🌟 Adding notes to shapes 📄You can now add notes to shapes, groups and layers by including a note field in your shape properties. For more information on how to do this, feel free to check out our documentation here!  JSON Import API FAQs 🙋 Q: Is the JSON import asynchronous? How will I know when the import is complete?No, it is actually synchronous. When the request is returned, the document is complete. Q: Is z-order for an entity based on array position? Last-on-top or first-on-top? (Does this mean lines are already "on top" of shapes, since it is a separate array?)In Lucid's JSON structure, z-order re

0
Sylvia X
3 months ago
Richard U
Richard ULucid support team
posted in Lucid for Developers

Your new community platform: a central hub for all Lucid developer resources

Welcome to our new community platform!You might have noticed some changes around here – that's because we've upgraded to a new platform for the entire Lucid Community, bringing new features and opportunities for all our members, including the Lucid for Developers community space. What’s new?Now you can earn builder badges, more dynamically engage with forum discussions, participate in Groups, and even send private messages to other Community members, and more easily format code in your posts and comments. As we make this exciting transition, it's the perfect opportunity to revisit the wealth of resources available for interacting with Lucid's APIs and building extensions. Key resources for interacting with Lucid's APIs and building extensions: Getting started with our public APIs: Visit our Development guide Review documentation for our REST API, Extension API, SCIM API, Custom Shapes and Formulas  Visit our Help Center article on Developer Tools Go to your Developer Portal and crea

0
Richard U
4 months ago
ben.bahrman@headintheclouddev.
ben.bahrman@headintheclouddev.
asked in Lucid for Developers

Error when refreshing token

We are getting intermittent errors when refreshing Oauth2 tokens in our Rest API integration. We are using a legacy token (Admin > App Integration > General >App Integrations > Custom OAuth apps) and the app has been working in our test environment for months. We recently deployed to production and more users are using it more regularly. The same user will get a refresh token error one moment and then when they try again it errors (see below).We did have a scheduled process that was retrieving all documents from each user and therefore hitting the API more frequently (once per user every 15 minutes),  we have stopped that process  temporarily to see if that helps, but would like to know if there are any other known issues which would be causing the intermittent issues. {"type":"http.ClientResponse","code":400,"headers":{"Alt-Svc":"h3=\":443\"; ma=93600","alt-svc":"h3=\":443\"; ma=93600","connection":"close","Connection":"close","Content-Length":"166","content-length":"166",

11
Michael B101
1 day ago
K
KGV
asked in Lucid for Developers

Reterive a Lucidchart document like the in Saved Versions

Hello,It is possible to navigate through saved versions of a document by clicking File>Revision History.Questions are:Can navigate through document versions using Lucid APIs?Is there a way I can set a document version name (ex: x.y) and retrieve/restore it when I want with Lucid APIs?

1
Humas1985
Lucid Legend Level 2
1 day ago
K
KGV
asked in Lucid for Developers

Extension APIs for blocks containers

Hello,I have a use case in LucidCharts where I need to identify if a block area is contained in another.In the documentation you can find this method getContainers() but it returns empty array for nested blocks. Those blocks seem to have valid bounding box values as well.Is there a correct way to use that API?

6
Connor B101
1 day ago
A
arajN2
asked in Lucid for Developers

Json Response

Currently we are using LucidChart for drawing fencing diagrams. We had some questions about the Json response that we get for Get Document contents. There is some data that raised a question for us. Our overall fencing diagram through lucid allows us to drop and drag gates and overall measurements for these fences and those are pulled in through the api. Some of the gates are showing up as ERRORS! within the Json response. Also the Lines class within our json response seems to be connected to these ERROR!. We were wondering if you can provide some insight on this, I will provide an example snippet of a Json response for a better understanding.    Json:  {    "id": "f48e1227-c6df-4f9b-ad00-20a81c271d26",    "title": "SITE-000000015",    "product": "lucidchart",    "pages": [        {            "id": "0_0",            "title": "Page 1",            "index": 0,            "items": {                "shapes": [                    {                        "id": "igj.W1Apzw4F",               

8
A
4 days ago
S
Steve Strassmann
asked in Lucid for Developers

Document content: edges are missing labels

I have created a diagram using Decision shapes with Yes and No lines. I am using the Developer API to retrieve the document content using GET https://api.lucid.co/documents/:id/contents The shapes have Text labels which are included in the retrieved content.However, as far as I can tell, the line labels are missing in the retrieved content. I am unable to tell which lines correspond to Yes or No connections. Am I missing something here? Is there some other way to disambiguate the connecting lines?   

2
S
4 days ago
S
Steve Strassmann
asked in Lucid for Developers

Bogus intermittent "too large" error from GET /documents/{docId}/content

I've developed an app which connects to the Lucid API and calls GET https://api.lucid.co/documents/{doc_id}/contents to retrieve the contents of a document.Most of the time, my request is successful: I get back a 200 response along with the JSON document.However sometimes the Lucid API server fails to return the document. Instead I see this error.Why is this happening? The document in question is only about 360KB, so it's not particularly large, and it is certainly not being modified by anyone.Error: {"code":"badRequest",        "message":"Bad or malformed request",        "requestId":"8964e70358ce692e",        "details":{"error":"Document 62563ead-aa4a-4d29-8f2d-858a0a163b0d is too large to retrieve contents."}} ContextThe scopes used to create the access token areconst SCOPES = ["lucidchart.document.content", "offline_access", "user.profile"];The document request isconst LUCID_API_HOST = "https://api.lucid.co";const url = `${LUCID_API_HOST}/documents/${docId}/contents`;const headers

6
Richard U
8 days ago
S
Sankalpa
asked in Lucid for Developers

Embed a document with Links

We have a react application and we are embedding lucid chart documents there. It works find until we click on other links. Imagine, I have a link within lucid chart to a different document. Once, I click on that link my expected behavior is to open that link within the iFrame but instead of that the link opens in the parent window. How can I control this behavior and open links within the iFrame ?  

5
S
8 days ago
L
ljarami
asked in Lucid for Developers

Api for get Approval Date

Hello, we are working with Lucid in our projects, we need to calculate to time. We need to get the approval Date of some documents by api. It is posible?

1
Richard U
22 days ago
J
jdsalesforce
asked in Lucid for Developers

Custom Shapes - Extension Click Handler

Looking through the custom shapes documentation I found the ‘Extension Click Handler’ topic.  Does this allow you to invoke functionality in an extension by clicking on a shape?  Is there any example code available?

2
J
27 days ago
M
marcin.wilkos
asked in Lucid for Developers

Comma in Text impacts the CONTAINED function in custom field

I’m using the REST API to export document contents to JSON.https://developer.lucid.co/rest-api/v1/#get-document-contentsIn my use case, I want to find the stick notes that belong to the container. For that purpose I’m using a custom field and the CONTAINED function.The JSON looks as follows: { "id": "vaXcl.RlvRIQ", "class": "SparkContainerBlock", "textAreas": [ { "label": "Text", "text": "People" } ], "customData": [ { "key": "Contained", "value": "[Not trained enough, Working overtime]" } ], "linkedData": []}If we change the sticky note text "Working overtime" to "Working overtime, exhausted and frustrated" then the JSON will look as follows. { "id": "vaXcl.RlvRIQ", "class": "SparkContainerBlock", "textAreas": [ { "label": "Text", "text": "People" } ], "customData": [ { "key": "Contained", "value": "[Not trained enough, Working overtime, exhausted and frustrated]" } ], "linkedData": []}As you can see the com

3
alyssa
1 month ago
P
PromitaDan
asked in Lucid for Developers

PanelLocation values other than RightDock?

Hello,In the Extension API, I am looking for all the options for PanelLocation.I see location: PanelLocation.RightDock.  Are there are locations?Thanks, Dan

3
Richard U
1 month ago
L
Lucas Brisingamen
asked in Lucid for Developers

Error 500 when uploading a Custom Shape Library

I keep getting an `Unknown error: 500` when trying to upload.  Already tried all troubleshooting steps outlined in the following article: Error 500 when trying to upload new custom shape package | Community (lucid.co) (New network, another device, repacked library, renamed library, tried on edge, edge incognito, chrome, phone).  Same error in all attempts.  

5
L
1 month ago
G
Guillaume
asked in Lucid for Developers

Error: Unsuccessful response from data-sync: network [object Object]

Hello,I face the following issue when I try to call an action from my data connector. I think I followed all the necessary steps to make it work. I well start the demon based on the debug-server.ts file :  I well declare it in the manifest​​​​I well defined the asynchronous actions  Here is the definition of the action :  Can someone help ? 

11
ablackburn
1 month ago
mwyman
mwyman
asked in Lucid for Developers

Using ElementProxy to get data fields for selected Jira card

Hello Lucid Devs and community.  I'm trying to get access to the data fields attached to a LucidSpark Card that was created using your Jira data connector/integration. I spoke with you all recently and you had suggested I leverage ElementProxy, but I’m having trouble getting it to work. Would greatly appreciate any help about where I’m going wrong. If you have any example code for this scenario that would be helpful as well. My 'extension.ts' file (stripped down to focus on just getting data fields):import { EditorClient, Menu, MenuType, Viewport, CardBlockProxy, DataProxy, ElementProxy, CollectionProxy,} from "lucid-extension-sdk";const client = new EditorClient();const menu = new Menu(client);const viewport = new Viewport(client);const data = new DataProxy(client);async function listDataFieldsForSelectedElement(elementId: string) { const elementProxy = new ElementProxy(elementId, client); let fieldsSet = new Set(); for (const referenceKey of elementProxy.referenceKeys.valu

12
Richard U
1 month ago
mwyman
mwyman
asked in Lucid for Developers

Error when using 'patchItems' to update field value

Hello all! I’m posting this as a new topic, although I believe it is related to Using ElementProxy to get data fields for selected Jira card. When I try to update a field value using ‘patchItems’ on the CollectionProxy I am getting an error message saying it “could not find collection...” I set up a simple demonstration in the code below for your review, with a hard-coded update value in string format. I picked a field called “summary” which is just a string to hopefully rule out type compatibility issues. Thanks again for all of your help!Here’s my function getFieldValueFromElement, and you can see that all of the read the fields from the collection (and display the collection itself) up until I execute the patch command.export async function getFieldValueFromElement( client: EditorClient, elementId: string, fieldName: string) { // Obtain an ElementProxy for the given elementId const elementProxy = new ElementProxy(elementId, client); // Check if elementProxy is null or undefine

1
Richard U
1 month ago
A
arajN2
asked in Lucid for Developers

Document Sharing via API

Hello,  I had a couple of concerns regarding the creation of documents via the API. Currently we are creating documents into the default folder but are having issues with users viewing them. Currently only Admins have the ability to view them. Regarding this we are wondering if there is a way to share documents that are created to organizational group? Are there other ways we could share the documents to users as well?

3
Richard U
1 month ago
mwyman
mwyman
asked in Lucid for Developers

Ability to manipulate dynamic tables?

Hello all! I had some general questions about your Dynamic Tables. Would appreciate any thoughts or to point me in the right direction. :)Is there a way through the Extension API or other means to access properties or methods for a Dynamic Table? Poking around I see that it is referred to as a “DynamicMatrixColumnBlockClassName” I think? Is there a way to read any properties such as column or row headings? Determine what cards are in a column/row/cell? (I know I’m pushing my luck here) Is there an ability to define Custom Column values and programmatically associate cards to the correct columns using custom logic? (Similar to the way the dynamic table auto shifts cards based on standard data fields assigned to Columns and Rows.)Thank you!Matt

1
Ian Baenziger
1 month ago
M
marcin.wilkos
asked in Lucid for Developers

This OAuth2 client is not available

My team developed a web application that uses a REST API to create and then embed the Lucid Chart documents into our website.We successfully tested the integration between our app and the Lucid. It works fine as long as the user is added to the collaborators in the developers panel.However, when other users test our application they get an error saying:“This OAuth2 client is not available”The account administrator installed our application package for the whole account, but the error still persists.We don’t use the Extension API and our application is totally external to the Lucid. We just need to use the REST API only. 

6
T
1 month ago
P
PromitaDan
asked in Lucid for Developers

LucidChart with React

Hello,I am following the steps from the LucidChart Developer Docs “Using web frameworks | Using React: found here.https://developer.lucid.co/guides/?_gl=1*mhld9f*_ga*MTA5NzkzMTU0NC4xNjk2NTE0NTk1*_ga_MPV5H3XMB5*MTcwODQ2MDk4My4xLjAuMTcwODQ2MDk4My42MC4wLjA.*_gcl_au*MTUzOTY2NTcwOS4xNzA4NDYwOTg1#using-reactI created an empty directory:  C:\ReactLucidTestFollowing step 1, i created a package called “reacttest”I also created an editor extension called “with-cool-ui’.In step 2, I created the react app called rightpanel inside of with-cool-ui extension.  npm start successfully launched my browser and showed the CRA application.In step 3, I opened up "C:\ReactLucidTest\reacttest\editorextensions\with-cool-ui\webpack.config.js" in notepad and replaced it with the code from the Developer Docs in step 3.In step 4, I opened up "C:\ReactLucidTest\reacttest\editorextensions\with-cool-ui\src\extension.ts" and replaced the contents with the code found in step 4 on Developer Docs in step 4.In step 5, I a

10
ablackburn
1 month ago
Richard U
Richard ULucid support team
published in Lucid for Developers

Tutorial: How to retrieve a JSON of any Lucidchart document with the Document Contents requestTutorial

Are you building an application with Lucid’s external APIs that uses our Document Contents endpoint? The Document Contents endpoint uses an OAuth token with User access scope to return a JSON that describes any document accessible by the User associated with the OAuth token. Read on for more information on what to expect in the response and what to do if you return an error.   Let’s take a look at a snippet from the JSON response for an example flowchart document to illustrate how the shapes on the canvas will be represented on the JSON. The magnifying glass in the screenshot below is covering a terminator shape labeled ‘Request complete’: The document content within the magnifying glass will be represented in the JSON as shown in the screenshot below: The object class (TerminatorBlock) is indicated as is the unique ItemId (q7NtnToLUGX9). Every individual shape line group and layer represented in the response will contain a unique value for ItemId to identify the object. For mor

1033
L
1 month ago
Laszlo P
Laszlo P
posted in Lucid for Developers

Simple Lucidchart viewer without scrolling for embedded charts

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? 

6
S
1 month ago
T
Taffin
asked in Lucid for Developers

License Management API

Hi,Currently we’re using SCIM to manage our user access and grant/remove licenses - this is working fine from our user management side for onboard/offboarding but has some caveats such as not being able to poll the license information directly, which has the potential to put us over our license count.Are there any APIs available for querying specifically information about our licenses? Ideally an endpoint that we can use to retrieve what products we’re licensed for, how many licenses are issued and how many are available would be brilliant. Cheers,Taffin

2
T
2 months ago
Terms & Conditions

Get Started

Products

Solutions

Resources

Company

Privacy Legal Cookie Policy Cookie Settings
©   2024  Lucid Software Inc.