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.
typestringDefault value: INSTALL_APP
Available values: The only valid value is INSTALL_APP.
appAuditLogAppA Canva app.
idstringThe app ID.
namestringThe name of the app.
versionstringThe version of the app.
permissionsstring[]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).
Example
{"id": ...,"timestamp": ...,"actor": ...,"target": ...,"action": {"type": "INSTALL_APP","app": {"id": "AAEJQA10wBV","name": "Magic App","version": 23},"permissions": ["DESIGN_CONTENT_READ"]},"outcome": ...,"context": ...}
Uninstall an app
An actor triggers this event when they remove a third-party app from their list of apps.
typestringDefault value: UNINSTALL_APP
Available values: The only valid value is UNINSTALL_APP.
appAuditLogAppA Canva app.
idstringThe app ID.
namestringThe name of the app.
versionstringThe version of the app.
Example
{"id": ...,"timestamp": ...,"actor": ...,"target": ...,"action": {"type": "UNINSTALL_APP","app": {"id": "AAEJQA10wBV","name": "Magic App","version": 23}},"outcome": ...,"context": ...}
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.
typestringDefault value: UPDATE_APP_PERMISSIONS
Available values: The only valid value is UPDATE_APP_PERMISSIONS.
appAuditLogAppA Canva app.
idstringThe app ID.
namestringThe name of the app.
versionstringThe version of the app.
old_permissionsstring[]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).
new_permissionsstring[]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).
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": ...}
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).
typestringDefault value: DISCONNECT_FROM_THIRD_PARTY_APP
Available values: The only valid value is DISCONNECT_FROM_THIRD_PARTY_APP.
appAuditLogAppA Canva app.
idstringThe app ID.
namestringThe name of the app.
versionstringThe 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": ...}
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).
typestringDefault value: CONNECT_TO_THIRD_PARTY_APP
Available values: The only valid value is CONNECT_TO_THIRD_PARTY_APP.
appAuditLogAppA Canva app.
idstringThe app ID.
namestringThe name of the app.
versionstringThe 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": ...}