Integration
Seamlessly Integrate notebook into external services. (This feature is currently under private preview)
How to Set Up
Prepare integration
Prepare API Key and Secret
Open "Workspace settings" and click menu "API Keys".
Click the "New API Key" button and create new API Key.
Make a note of the API Key and API Secret (they will be used later for API calls).
Open the Notebook
Open the notebook you want to share.
Click the "Share" button in the header and select "Integration".
Select Pages
Choose the pages you want to publish.
Publish
Click the "Publish" button.
Configure integration settings.
Add API Key to use in "Permitted API Keys" section.
If you want to overwrite parameter values via the API, configure them in the Externalized Params section
Issue token from server
The following API is used to issue a token
The required arguments for calling the API can be found on the Integration settings page.
Perform the API call on the server side to prevent the API Secret from being exposed externally.
Issue a token for each user session, and do not reuse it (it expires after 1 hour).
Embed notebook
Create an iframe element and load
Integration URL
and pass token to authenticate.
[Recommended] Pattern1. Passing token via postMessage
Create an iframe element with
Integration URL
as the src attributeWait for a
{type: "READY_FOR_TOKEN"}
message from the iframe via postMessageSend
{type: "SET_TOKEN", token: "{{ TOKEN_HERE }}"}
message back to the iframe via postMessage
Pattern2. Passing token via URL parameter
Append token as a query parameter to the
Integration URL
(?token=xxx
)Create an iframe element with the modified URL as the src attribute
Appendix: Message list
Messages can be exchanged using the iframe's postMessage function.
The messages are also output to
console.debug()
, so you can check the actual message content there.For example, this functionality can be used to:
Persist parameter information modified by users.
Share parameters across different integrations or pages.
Below is a list of messages that can be sent and received.
Messages to the iframe
type | description |
---|---|
| Set the authentication token and start rendering notebook. This message must be sent after receiving the |
Messages from the iframe
type | description |
---|---|
| Notification that the notebook is ready to receive the token. |
| Sent each time the user modifies a parameter within the notebook. |
| Sent when 'Run all' is executed within the notebook. |
Last updated