onMultiArtworkCreate

Registers a callback that runs when a user finishes proofing their design.

This feature is in a closed, invite-only beta.

The Partnership SDK refers to a proofed design as an artwork.

Usage

(async () => {
const api = await Canva.Partnership.initialize({
apiKey: "<partner_api_key>",
autoAuthToken: "<auto_auth_token>",
container: document.getElementById("container"),
});
const onMultiArtworkCreate = (opts) => {
opts.artworks.forEach((artwork) => {
console.log(artwork);
});
};
const onProductSelect = (opts) => {
api.createDesign({
...opts,
onMultiArtworkCreate,
});
};
api.showCatalog({
onProductSelect,
});
})();

Parameters

Name

Type

Required

Description

opts

object

Yes

Information about the user's proofed design.

opts.artworks

Array<Artwork>

Yes

List of artworks representing the user's proofed designs.

Types

Artwork

Represents an individual artwork.

Properties

To understand the meaning of the Volatile column, see the definition of Volatile parameters in the Glossary.

Name

Type

Required

Volatile

Description

previewImages

Array

Yes

Yes

A list of URLs for previewing a low-resolution version of the artwork. For JPG and PNG file formats, there's a separate URL for each page. For PDF file formats, there's one URL for the entire preview. The URL is in the form https://partnership-artwork.canva.com/<export_file>. If you're using the China version of the SDK, the TLD is .cn instead of .com. You can take the necessary security measures to protect the URL from any malicious attacks.

previewImageSrc (deprecated)

string

Yes

Yes

The URL of a low-resolution preview of the artwork. This parameter is superseded by previewImages.

artworkId

string

Yes

No

The ID of the user's artwork.

artworkTitle

string

Yes

No

The title of the user's artwork.

designId

string

Yes

No

The design ID of the user's artwork.

pageCount

number

Yes

No

The number of the pages in the artwork.

partnerProductId

string

Yes

No

The ID of a product in the partner's backend.