Skip navigation

Skip to main content

The Extensions documentation is no longer updated. Read the new Canva API docs here.

App Development

Overview Quickstart Changelog

Platform concepts

Apps Extensions Regions Authentication Deprecation policy

Extensions

Content extensions Publish extensions

Backend development

Base URL Continuation Signature verification SDKs

Distribution

UX guidelines Submission checklist Creating the App Directory listing

Server API

Overview GET /apps/configured POST /configuration POST /configuration/delete POST /content/resources/find POST /publish/resources/find POST /publish/resources/get POST /publish/resources/upload Redirect URL

Reference

Redirect URL

API reference for the "Redirect URL" endpoint.

When a user attempts to authenticate with an app, Canva begins the authentication flow by opening a pop-up window. This window:

Redirects users to the app's Redirect URL.
Appends query parameters to the Redirect URL.

You can configure an app's Redirect URL via the Developer Portal.

The query parameters include the user's ID, which the app can use to authenticate the user.

To learn more, refer to Authentication.

Request

Endpoint

GET <redirect_url>

BASH

Query

Properties

Property	Type	Required	Description
`brand`	string	Yes	The ID of the user's team.
`extensions`	string	Yes	The extension points the user is attempting to authenticate with.
`signatures`	string	Yes	A comma-separated list of request signatures.
`state`	string	Yes	A token the app must return to Canva at the end of the authentication flow.
`time`	string	Yes	The UNIX timestamp (in seconds) of when the user started the authentication flow.
`user`	string	Yes	The ID of the user.

Example

<redirect_url>?brand=<brand>&extensions=<extensions>&signatures=<signatures>&state=<state>&time=<time>&user=<user>

BASH