If an app supports authentication and has a publish extension, Canva sends a POST request to the following endpoint when a user opens the extension:

<authentication_base_url>/configuration

The purpose of this request is to check if the user is authenticated with the destination platform.

If the user is authenticated, the extension continues to load. If the user is not authenticated, Canva renders a Connect button. The user can click this button to start the authentication flow.

To learn more, refer to Authentication.

Notes

• Extensions must respond to this request within 8 seconds.

• When sending this request, Canva replaces <authentication_base_url> with the app's Authentication base URL. You can configure the Authentication base URL via the app's Authentication page.

Request

Endpoint

POST <authentication_base_url>/configuration

Headers

Body

Properties

Example

{
  "user": "<user>",
  "brand": "<brand>"
}

Responses

200 - Success (user is authenticated)

The response the app provides when the user is authenticated with the destination platform.

Properties

Example

{
  "labels": [],
  "type": "SUCCESS"
}

200 - Error (user not authenticated)

The response the app provides when the user is not authenticated with the destination platform.

Properties

Example

{
  "type": "ERROR",
  "errorCode": "CONFIGURATION_REQUIRED"
}

200 - Error (other)

The response the app provides when an error occurs.

Properties

Example

{
  "type": "ERROR",
  "errorCode": "<error_code>"
}

401 - Invalid request signature or timestamp

An extension must verify the request signature and timestamp of all incoming requests. When an extension can't verify either of these values, it must reject the request with a 401 status code.