Sigma REST APIWorkbooksembeds

Create an embed for a workbook

View as Markdown
This endpoint lets you create an embed for a specific workbook. You can embed an entire workbook, a specific page, or an individual element within a workbook. Embedding enables seamless integration of Sigma content into other applications, websites, or internal platforms, providing a flexible and dynamic way to present and interact with data. ### Embedding options - Publicly embed Sigma in a public website by creating an embed of type `public`. - Securely embed Sigma in an authenticated host application. - (Recommended) Use JSON Web Tokens (JWT) to sign the workbook URL outputted by the [/v2/workbooks](https://help.sigmacomputing.com/reference/list-workbooks) endpoint instead of the output of this endpoint. See [Create a secure embed](/docs/create-a-secure-embed). - (Deprecated) Use this endpoint to create an embed of type `secure`. This option is deprecated. See [Migrate to JWT-signed secure embed URLs](/docs/migrate-to-jwt-signed-secure-embed-urls). ### Usage notes - The endpoint requires the workbookId as a path parameter. Retrieve the **workbookId** by calling the [/v2/workbooks](https://help.sigmacomputing.com/reference/list-workbooks) endpoint. - The body of the request must specify the type of embed (public). - You must specify the source type (workbook, page, element) and ID for that source to create the embed. - Retrieve the **pageId** by calling the [/v2/workbooks/{workbookId}/pages](https://help.sigmacomputing.com/reference/list-workbook-pages) endpoint. - Retrieve the **elementId** by first calling the [/v2/workbooks/{workbookId}/pages](https://help.sigmacomputing.com/reference/list-workbook-pages) endpoint, then calling the [/v2/workbooks/{workbookId}/pages/{pageId}/elements](https://help.sigmacomputing.com/reference/list-workbook-page-elements) endpoint. ### Usage scenarios - **Web application integration:** Developers can use this API to generate the embed URL for integration into their application or for display on a public-facing webpage. ### Best practices - Validate the `workbookId` and `sourceId` to ensure they refer to existing resources before attempting to create an embed. - Consider the security settings of the embed type to match the integration context, ensuring that data exposure is controlled and appropriate for the audience.

Authentication

AuthorizationBearer

OAuth authentication of the form <token>.

Path parameters

workbookIdstringRequired

Request

The request body.
embedTypeenumRequired

Defines the visibility and access control of the embed. Choose public for open access.

Allowed values:
sourceTypeenumRequired

Specifies the scope of the embed: “workbook” for the entire workbook, “page” for a single page, or “element” for a specific element within the workbook.

Allowed values:
sourceIdstringOptional
The specific identifier for the page or element to be embedded if the sourceType is "page" or "element".

Response

The response body.
embedIdstring
Unique identifier of the embed.
embedUrlstring