onArtworkCreate

Registers a callback that runs when a user finishes proofing their design.
(async () => {
const api = await Canva.Partnership.initialize({
apiKey: "<partner_api_key>",
autoAuthToken: "<auto_auth_token>",
container: document.getElementById("container"),
});
const onArtworkCreate = (opts) => {
// the user has finished proofing their design
console.log(opts);
};
const onProductSelect = (opts) => {
api.createDesign({
...opts,
onArtworkCreate,
});
};
api.showCatalog({
onProductSelect,
});
})();
javascript
NameTypeRequiredVolatileDescription
optsobjectYesN/AInformation about the user's proofed design.
opts.previewImagesArray<string>YesYesA 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.
opts.previewImageSrc (deprecated)stringYesYesThe URL of a low-resolution preview of the artwork. This parameter is superseded by opts.previewImages.
opts.artworkIdstringYesNoThe ID of the user's artwork.
opts.artworkTitlestringYesNoThe title of the user's artwork.
opts.pageCountnumberYesNoThe number of the pages in the artwork.
opts.partnerProductIdstringYesNoThe ID of a product in Canva's back-end. A partner product ID determines the dimensions, the templates, the furniture (if applicable), and the export settings to apply for a design. A partner may provide a partner product ID to Canva beforehand. This may match with a product ID in a partner's back-end, such as SKU or internal system identifier. If partner doesn't provide a partner product ID, Canva assigns one for each product.