FAQs: How can others view a project progress? In GUIDEcx, in their email inbox, on their mobile phone and embedded anywhere else you'd like!
Do you need a GUIDEcx account to see project status? Nope.
Can I share my Project information without creating login access for someone? Yes you can.
Embed an iframe of your Project Overview
We've added the ability to embed an iframe or "Read Only Version" of the project overview into other locations of your choosing (website, other applications, etc.). The embed code can be accessed via one of two ways:
Through the "Share Button" on the project overview.
Pro Tip: Use this functionality to share your project with individuals that aren't team members of the project.
2. Through our Open API
With the API, you can get the share link that you'll need for the embed code via the webhook payload. Here's how...
One thing to clarify first: you will be able to find the specific project information you need for the embed code (we'll show you how to do that with the API below). Then, you will need to write logic to put that project information into the full iframe embed code (which we'll provide below as well). The method of writing that script isn't something we have documented, since it will all be different based on where and how you are embedding into a different system, but this should get you everything you need from the GUIDEcx side.
There are two ways to grab the information you need. The first gets you the entire link you need to add to the embed code, so it may be preferable in that sense. It is received via the webhook payload, which brings back a lot of information, so depending on your preference, we'll include a second, bonus way to do this at the end.
The first way: webhook
To do this, you'll make a POST call for the webhook payload and the information you want is going to come back in the response as the "publicProjectUrl"
Then, you'll need to know the structure of the embed code. Notice it is always the same for every project except for the project ID.
It looks like this:
<iframe src="https://app.guidecx.com/shared-project/d2a98794-b2c6-4275-9674-f42228272765
/overview" name="shareableProject" frameborder="1" width="100%" height="100%" allowfullscreen></iframe>
Again, the webhook approach is nice because it gives you a bigger chunk of the share URL (e.g. "https://app.guidecx.com/shared-project/d2a98794-b2c6-4275-9674-f42228272765/overview"), but it also gives you much more information, so if you'd like to approach this another way...
The second way: GET Project List
This approach will only get you the project ID (the bold portion of the embed code above).
To do this, you will use the GET call for a list of projects and the information you want is going to come back in the response as the "id"
You will then pass that project ID into the right spot in the embed code for your iframe.
Let us know how it goes and if any questions come up!