Apps

Install an app

An actor triggers this event when they use a third-party app for the first time (or following app uninstall). For example, when a user selects "open" on a new app in the editor, or selects Use in a new design or Use in existing design from the apps marketplace⁠(opens in a new tab or window). The installation is for a user in a team.

typestring

Default value: INSTALL_APP

Available values: The only valid value is INSTALL_APP.

appAuditLogApp

A Canva app.

idstring

The app ID.

namestring

Optional

The name of the app.

versionstring

Optional

The version of the app.

permissionsstring[]

Optional

A set of permissions.

Available values:

DESIGN_CONTENT_READ: Permission to view design content.
DESIGN_CONTENT_WRITE: Permission to modify design content.
ASSET_PRIVATE_READ: Permission to view private assets.
ASSET_PRIVATE_WRITE: Permission to modify private assets.
BRANDKIT_READ: Permission to view Brand Kits⁠(opens in a new tab or window).
BRAND_TEMPLATE_READ: Permission to view Brand Templates⁠(opens in a new tab or window).

settingsstring[]

Optional

A set of settings.

Available values: The only valid value is ENABLED_FOR_CANVA_AI: The app is available for Canva AI to use..

canva_ai_permissionsAppCanvaAiPermissions

Optional

The permissions for how Canva AI uses an app.

enabledboolean

has_server_addressboolean

The actor set a server address. The actual value is sensitive and is not included.

tool_permissionsAppCanvaAiToolPermission[]

Optional

The tool permissions the actor set for using an app with Canva AI.

namestring

The name of the tool.

permissionstring

How a tool may be used by Canva AI.

Available values:

ALWAYS_ALLOW: Canva AI is always allowed to use the tool.
ASK_EVERY_TIME: Canva AI will always ask before using the tool.
BLOCKED: Canva AI is never allowed to use the tool.

Example

{
  "id": ...,
  "timestamp": ...,
  "actor": ...,
  "target": ...,
  "action": {
    "type": "INSTALL_APP",
    "app": {
      "id": "AAEJQA10wBV",
      "name": "Magic App",
      "version": 23
    },
    "permissions": [
      "DESIGN_CONTENT_READ"
    ],
    "settings": [
      "ENABLED_FOR_CANVA_AI"
    ],
    "canva_ai_permissions": {
      "enabled": true,
      "has_server_address": true,
      "tool_permissions": [
        {
          "name": "spell-checker-tool",
          "permission": "ALWAYS_ALLOW"
        }
      ]
    }
  },
  "outcome": ...,
  "context": ...
}

JSON

Uninstall an app

An actor triggers this event when they remove a third-party app from their list of apps.

typestring

Default value: UNINSTALL_APP

Available values: The only valid value is UNINSTALL_APP.

appAuditLogApp

A Canva app.

idstring

The app ID.

namestring

Optional

The name of the app.

versionstring

Optional

The version of the app.

Example

{
  "id": ...,
  "timestamp": ...,
  "actor": ...,
  "target": ...,
  "action": {
    "type": "UNINSTALL_APP",
    "app": {
      "id": "AAEJQA10wBV",
      "name": "Magic App",
      "version": 23
    }
  },
  "outcome": ...,
  "context": ...
}

JSON

Update an app's permissions

An actor triggers this event when they accept updated permissions for an installed third-party app. The app's developer may have updated the permissions required by the app.

typestring

Default value: UPDATE_APP_PERMISSIONS

Available values: The only valid value is UPDATE_APP_PERMISSIONS.

appAuditLogApp

A Canva app.

idstring

The app ID.

namestring

Optional

The name of the app.

versionstring

Optional

The version of the app.

old_permissionsstring[]

Optional

A set of permissions.

Available values:

DESIGN_CONTENT_READ: Permission to view design content.
DESIGN_CONTENT_WRITE: Permission to modify design content.
ASSET_PRIVATE_READ: Permission to view private assets.
ASSET_PRIVATE_WRITE: Permission to modify private assets.
BRANDKIT_READ: Permission to view Brand Kits⁠(opens in a new tab or window).
BRAND_TEMPLATE_READ: Permission to view Brand Templates⁠(opens in a new tab or window).

new_permissionsstring[]

Optional

A set of permissions.

Available values:

DESIGN_CONTENT_READ: Permission to view design content.
DESIGN_CONTENT_WRITE: Permission to modify design content.
ASSET_PRIVATE_READ: Permission to view private assets.
ASSET_PRIVATE_WRITE: Permission to modify private assets.
BRANDKIT_READ: Permission to view Brand Kits⁠(opens in a new tab or window).
BRAND_TEMPLATE_READ: Permission to view Brand Templates⁠(opens in a new tab or window).

Example

{
  "id": ...,
  "timestamp": ...,
  "actor": ...,
  "target": ...,
  "action": {
    "type": "UPDATE_APP_PERMISSIONS",
    "app": {
      "id": "AAEJQA10wBV",
      "name": "Magic App",
      "version": 23
    },
    "old_permissions": [
      "DESIGN_CONTENT_READ"
    ],
    "new_permissions": [
      "DESIGN_CONTENT_READ"
    ]
  },
  "outcome": ...,
  "context": ...
}

JSON

Update a setting for an app

An actor triggers this event when they update a setting for an app.

typestring

Default value: UPDATE_APP_SETTING

Available values: The only valid value is UPDATE_APP_SETTING.

appAuditLogApp

A Canva app.

idstring

The app ID.

namestring

Optional

The name of the app.

versionstring

Optional

The version of the app.

settingstring

The setting for an app.

Available values: The only valid value is ENABLED_FOR_CANVA_AI: The app is available for Canva AI to use..

old_valueboolean

new_valueboolean

Example

{
  "id": ...,
  "timestamp": ...,
  "actor": ...,
  "target": ...,
  "action": {
    "type": "UPDATE_APP_SETTING",
    "app": {
      "id": "AAEJQA10wBV",
      "name": "Magic App",
      "version": 23
    },
    "setting": "ENABLED_FOR_CANVA_AI",
    "old_value": true,
    "new_value": true
  },
  "outcome": ...,
  "context": ...
}

JSON

Update an app's Canva AI permissions

An actor triggers this event when they update the Canva AI permissions for an app.

typestring

Default value: UPDATE_APP_CANVA_AI_PERMISSIONS

Available values: The only valid value is UPDATE_APP_CANVA_AI_PERMISSIONS.

appAuditLogApp

A Canva app.

idstring

The app ID.

namestring

Optional

The name of the app.

versionstring

Optional

The version of the app.

changed_fieldsstring[]

Optional

The fields that were changed in this update.

Available values:

ENABLED: The enabled field was changed.
TOOL_PERMISSIONS: One or more tool permissions were changed.
SERVER_ADDRESS: The server address was changed. The actual value is sensitive and is not included.

old_enabledboolean

Optional

Whether Canva AI permissions were enabled before this update.

new_enabledboolean

Optional

Whether Canva AI permissions were enabled after this update.

tool_permission_changesUpdateAppCanvaAiToolPermissionChange[]

Optional

The tool permissions the actor requested changes for in this update.

The actor added a permission for how a tool may be used by Canva AI.

typestring

Default value: ADD_APP_CANVA_AI_TOOL_PERMISSION

Available values: The only valid value is ADD_APP_CANVA_AI_TOOL_PERMISSION.

namestring

The name of the tool.

permissionstring

How a tool may be used by Canva AI.

Available values:

ALWAYS_ALLOW: Canva AI is always allowed to use the tool.
ASK_EVERY_TIME: Canva AI will always ask before using the tool.
BLOCKED: Canva AI is never allowed to use the tool.

The actor removed a permission for how a tool may be used by Canva AI.

typestring

Default value: REMOVE_APP_CANVA_AI_TOOL_PERMISSION

Available values: The only valid value is REMOVE_APP_CANVA_AI_TOOL_PERMISSION.

namestring

The name of the tool.

permissionstring

How a tool may be used by Canva AI.

Available values:

ALWAYS_ALLOW: Canva AI is always allowed to use the tool.
ASK_EVERY_TIME: Canva AI will always ask before using the tool.
BLOCKED: Canva AI is never allowed to use the tool.

The actor updated a permission for how a tool may be used by Canva AI.

typestring

Default value: UPDATE_APP_CANVA_AI_TOOL_PERMISSION

Available values: The only valid value is UPDATE_APP_CANVA_AI_TOOL_PERMISSION.

namestring

The name of the tool.

old_permissionstring

How a tool may be used by Canva AI.

Available values:

ALWAYS_ALLOW: Canva AI is always allowed to use the tool.
ASK_EVERY_TIME: Canva AI will always ask before using the tool.
BLOCKED: Canva AI is never allowed to use the tool.

new_permissionstring

How a tool may be used by Canva AI.

Available values:

ALWAYS_ALLOW: Canva AI is always allowed to use the tool.
ASK_EVERY_TIME: Canva AI will always ask before using the tool.
BLOCKED: Canva AI is never allowed to use the tool.

Example

{
  "id": ...,
  "timestamp": ...,
  "actor": ...,
  "target": ...,
  "action": {
    "type": "UPDATE_APP_CANVA_AI_PERMISSIONS",
    "app": {
      "id": "AAEJQA10wBV",
      "name": "Magic App",
      "version": 23
    },
    "changed_fields": [
      "ENABLED",
      "TOOL_PERMISSIONS",
      "SERVER_ADDRESS"
    ],
    "old_enabled": true,
    "new_enabled": true,
    "tool_permission_changes": [
      {
        "type": "ADD_APP_CANVA_AI_TOOL_PERMISSION",
        "name": "spell-checker-tool",
        "permission": "ALWAYS_ALLOW"
      },
      {
        "type": "REMOVE_APP_CANVA_AI_TOOL_PERMISSION",
        "name": "spell-checker-tool",
        "permission": "ALWAYS_ALLOW"
      },
      {
        "type": "UPDATE_APP_CANVA_AI_TOOL_PERMISSION",
        "name": "spell-checker-tool",
        "old_permission": "ALWAYS_ALLOW",
        "new_permission": "ALWAYS_ALLOW"
      }
    ]
  },
  "outcome": ...,
  "context": ...
}

JSON

Disconnect from a third-party service through an app

An actor triggers this event when they disconnect from a third-party service from within a third-party app installed in Canva. For example, a user disconnects from Google Drive in the Google Drive App⁠(opens in a new tab or window).

typestring

Default value: DISCONNECT_FROM_THIRD_PARTY_APP

Available values: The only valid value is DISCONNECT_FROM_THIRD_PARTY_APP.

appAuditLogApp

A Canva app.

idstring

The app ID.

namestring

Optional

The name of the app.

versionstring

Optional

The version of the app.

Example

{
  "id": ...,
  "timestamp": ...,
  "actor": ...,
  "target": ...,
  "action": {
    "type": "DISCONNECT_FROM_THIRD_PARTY_APP",
    "app": {
      "id": "AAEJQA10wBV",
      "name": "Magic App",
      "version": 23
    }
  },
  "outcome": ...,
  "context": ...
}

JSON

Connect to a third-party service through an app

An actor triggers this event when they connect to a third-party service using a third-party app installed in Canva. For example, a user connects to Google Drive using the Google Drive App⁠(opens in a new tab or window).

typestring

Default value: CONNECT_TO_THIRD_PARTY_APP

Available values: The only valid value is CONNECT_TO_THIRD_PARTY_APP.

appAuditLogApp

A Canva app.

idstring

The app ID.

namestring

Optional

The name of the app.

versionstring

Optional

The version of the app.

Example

{
  "id": ...,
  "timestamp": ...,
  "actor": ...,
  "target": ...,
  "action": {
    "type": "CONNECT_TO_THIRD_PARTY_APP",
    "app": {
      "id": "AAEJQA10wBV",
      "name": "Magic App",
      "version": 23
    }
  },
  "outcome": ...,
  "context": ...
}

JSON