Apps
Install 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).
typestringThe value for this can only be INSTALL_APP.
app_idstringThe ID of the app.
app_versionstringThe version of the app.
app_namestringThe name of the app.
permissionsstring[]A set of permissions. This can be an array of the following:
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).
Example
{"id": ...,"timestamp": ...,"actor": ...,"target": ...,"action": {"type": "INSTALL_APP","app_id": "AAEJQA10wBV","app_version": 23,"app_name": "Magic App","permissions": ["DESIGN_CONTENT_READ"]},"outcome": ...,"context": ...}
Uninstall app
An actor triggers this event when they remove a third-party app from their list of apps.
typestringThe value for this can only be UNINSTALL_APP.
app_idstringThe ID of the app.
app_versionstringThe version of the app.
app_namestringThe name of the app.
Example
{"id": ...,"timestamp": ...,"actor": ...,"target": ...,"action": {"type": "UNINSTALL_APP","app_id": "AAEJQA10wBV","app_version": 23,"app_name": "Magic App"},"outcome": ...,"context": ...}
Update app
An actor triggers this event when accept updated permissions for an installed
third-party app. The app's developer may have updated the permissions required by the app.
typestringThe value for this can only be UPDATE_APP_PERMISSIONS.
app_idstringThe ID of the app.
app_versionstringThe version of the app.
app_namestringThe name of the app.
old_permissionsstring[]A set of permissions. This can be an array of the following:
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).
new_permissionsstring[]A set of permissions. This can be an array of the following:
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).
Example
{"id": ...,"timestamp": ...,"actor": ...,"target": ...,"action": {"type": "UPDATE_APP_PERMISSIONS","app_id": "AAEJQA10wBV","app_version": 23,"app_name": "Magic App","old_permissions": ["DESIGN_CONTENT_READ"],"new_permissions": ["DESIGN_CONTENT_READ"]},"outcome": ...,"context": ...}
Deauthorize user with an app
An actor triggers this event when they de-authenticate from a third-party service from within
a third-party app
installed in Canva.
For example, a user de-authenticates from Google Drive in the Google Drive App(opens in a new tab or window).
typestringThe value for this can only be DEAUTHORIZE_USER_WITH_APP.
app_idstringThe ID of the app.
app_versionstringThe version of the app.
app_namestringThe name of the app.
Example
{"id": ...,"timestamp": ...,"actor": ...,"target": ...,"action": {"type": "DEAUTHORIZE_USER_WITH_APP","app_id": "AAEJQA10wBV","app_version": 23,"app_name": "Magic App"},"outcome": ...,"context": ...}
Authorize user with an app
An actor triggers this event when they authenticate to a third-party service using a third-party
app
installed in Canva. For example, a user authenticates to Google Drive using the Google Drive App(opens in a new tab or window).
typestringThe value for this can only be AUTHORIZE_USER_WITH_APP.
app_idstringThe ID of the app.
app_versionstringThe version of the app.
app_namestringThe name of the app.
Example
{"id": ...,"timestamp": ...,"actor": ...,"target": ...,"action": {"type": "AUTHORIZE_USER_WITH_APP","app_id": "AAEJQA10wBV","app_version": 23,"app_name": "Magic App"},"outcome": ...,"context": ...}