Skip navigation

Skip to main content

Canva Audit Logs are currently in development (Beta) and are subject to change at Canva's sole discretion.

Designs

Create a design

An actor triggers this event when they create a new design in Canva. This includes when a user creates a design from a template, or using a Canva App or Canva Integration.

typestring

Default value: CREATE_DESIGN

Available values: The only valid value is CREATE_DESIGN.

create_typestring
OPTIONAL

The activity type for creating a design.

Available values:

  • CREATE: Created a new blank design or a new design from a template.
  • CREATE_BY_UPLOAD: Created by using an uploaded asset.
  • CREATE_BY_REMIX: Created a copy of an existing design.
titlestring
OPTIONAL

Title of the new design.

original_design_idstring
OPTIONAL

When remixing designs, this is the original design's ID.

design_typestring
OPTIONAL

The type of design, such as "Presentation (16:9)", "Document", or "Instagram Post (Square)".

Example

{
  "id": ...,
  "timestamp": ...,
  "actor": ...,
  "target": ...,
  "action": {
    "type": "CREATE_DESIGN",
    "create_type": "CREATE",
    "title": "My awesome design",
    "original_design_id": "DAGKs37VOUl",
    "design_type": "Presentation (16:9)"
  },
  "outcome": ...,
  "context": ...
}
JSON

Copy a design

An actor triggers this event when they make a copy of an existing design.

typestring

Default value: COPY_DESIGN

Available values: The only valid value is COPY_DESIGN.

original_design_idstring

The ID of the original design.

titlestring
OPTIONAL

Title of the new design.

Example

{
  "id": ...,
  "timestamp": ...,
  "actor": ...,
  "target": ...,
  "action": {
    "type": "COPY_DESIGN",
    "title": "My awesome design",
    "original_design_id": "DAGKs37VOUl"
  },
  "outcome": ...,
  "context": ...
}
JSON

View a design

An actor triggers this event when they view a design. Actors viewing a publicly shared design without logging in are recorded as ANONYMOUS.

typestring

Default value: VIEW_DESIGN

Available values: The only valid value is VIEW_DESIGN.

view_typestring

The activity type for viewing a design.

Available values:

  • VIEW_IN_EDITOR: Viewed in the editor.
  • VIEW_IN_VIEWER: Viewed in the viewer.
design_typestring
OPTIONAL

The type of design, such as "Presentation (16:9)", "Document", or "Instagram Post (Square)".

Example

{
  "id": ...,
  "timestamp": ...,
  "actor": ...,
  "target": ...,
  "action": {
    "type": "VIEW_DESIGN",
    "view_type": "VIEW_IN_EDITOR",
    "design_type": "Presentation (16:9)"
  },
  "outcome": ...,
  "context": ...
}
JSON

View a design from a share link

An actor triggers this event when they open a design from a share link, and gain access to that design.

typestring

Default value: ACCEPT_DESIGN_SHARE

Available values: The only valid value is ACCEPT_DESIGN_SHARE.

Example

{
  "id": ...,
  "timestamp": ...,
  "actor": ...,
  "target": ...,
  "action": {
    "type": "ACCEPT_DESIGN_SHARE"
  },
  "outcome": ...,
  "context": ...
}
JSON

Import a file to create a new design

An actor triggers this event when they import a file into Canva to create a new design. This includes uploaded presentations and PDFs, and doesn't include Canva design assets, such as images and videos.

typestring

Default value: IMPORT_DESIGN

Available values: The only valid value is IMPORT_DESIGN.

titlestring

The title of the imported design.

file_typestring

The file type of the imported file, such as:

  • PPTX for a Microsoft PowerPoint presentations.
  • PDF for Portable Document Format files.

Example

{
  "id": ...,
  "timestamp": ...,
  "actor": ...,
  "target": ...,
  "action": {
    "type": "IMPORT_DESIGN",
    "title": "My awesome design",
    "file_type": "PPTX"
  },
  "outcome": ...,
  "context": ...
}
JSON

Trash a design

An actor triggers this event when they move a design to the trash folder. Designs in the trash folder aren't accessible to collaborators and will be deleted after a period of time. For details, see: Deleting designs⁠(opens in a new tab or window).

typestring

Default value: TRASH_DESIGN

Available values: The only valid value is TRASH_DESIGN.

Example

{
  "id": ...,
  "timestamp": ...,
  "actor": ...,
  "target": ...,
  "action": {
    "type": "TRASH_DESIGN"
  },
  "outcome": ...,
  "context": ...
}
JSON

Restore a design from Trash

An actor triggers this event when they restore a design from the trash folder. For details, see: Restoring or deleting designs or files from your Trash⁠(opens in a new tab or window).

typestring

Default value: UNTRASH_DESIGN

Available values: The only valid value is UNTRASH_DESIGN.

Example

{
  "id": ...,
  "timestamp": ...,
  "actor": ...,
  "target": ...,
  "action": {
    "type": "UNTRASH_DESIGN"
  },
  "outcome": ...,
  "context": ...
}
JSON

Delete a design from Trash

An actor triggers this event when they permanently delete a design from the trash folder. Deleting a user's account will also delete all the designs in their trash folder.

typestring

Default value: DELETE_DESIGN

Available values: The only valid value is DELETE_DESIGN.

Example

{
  "id": ...,
  "timestamp": ...,
  "actor": ...,
  "target": ...,
  "action": {
    "type": "DELETE_DESIGN"
  },
  "outcome": ...,
  "context": ...
}
JSON

Restore a deleted design

An actor triggers this event when they restore a recently deleted design. For example, when restoring a deleted user or team account⁠(opens in a new tab or window), the designs deleted with the account will also be restored. Designs in the trash when the account was deleted will be restored to the trash folder.

typestring

Default value: UNDELETE_DESIGN

Available values: The only valid value is UNDELETE_DESIGN.

Example

{
  "id": ...,
  "timestamp": ...,
  "actor": ...,
  "target": ...,
  "action": {
    "type": "UNDELETE_DESIGN"
  },
  "outcome": ...,
  "context": ...
}
JSON

Update a design's access controls

An actor triggers this event when they change the rules that control access to a design. There can be multiple changes in a single update.

typestring

Default value: UPDATE_DESIGN_ACCESS_CONTROLS

Available values: The only valid value is UPDATE_DESIGN_ACCESS_CONTROLS.

changesUpdateDesignAccessControlChange[]

A change to the rules that control the access to the design.

Properties of changes
typestring

This can be one of the following:

token_prefixstring
CONDITIONAL

The prefix of the access token for the design.

accessDesignAccessLevel
CONDITIONAL

Whether the design's content can be viewed or edited.

Properties of access
readboolean

Whether read access has been provided (true) or denied (false).

writeboolean

Whether write access has been provided (true) or denied (false).

commentboolean
OPTIONAL

Whether comment access has been provided (true) or denied (false).

recipientstring
CONDITIONAL

The recipient of the invitation. This property contains the address used to share the design, such as the recipient's email address, Slack ID, or mobile number.

userAuditLogUser
CONDITIONAL

A Canva user.

Properties of user
idstring

The user ID.

display_namestring
OPTIONAL

The display name of the user.

For privacy reasons, this field is redacted for users outside of your organization. Rarely, it may also be unavailable for technical reasons.

emailstring
OPTIONAL

The email address of the user.

For privacy reasons, this field is redacted for users outside of your organization. Rarely, it may also be unavailable for technical reasons.

old_ownerAuditLogUser
CONDITIONAL

A Canva user.

Properties of old_owner
idstring

The user ID.

display_namestring
OPTIONAL

The display name of the user.

For privacy reasons, this field is redacted for users outside of your organization. Rarely, it may also be unavailable for technical reasons.

emailstring
OPTIONAL

The email address of the user.

For privacy reasons, this field is redacted for users outside of your organization. Rarely, it may also be unavailable for technical reasons.

new_ownerAuditLogUser
CONDITIONAL

A Canva user.

Properties of new_owner
idstring

The user ID.

display_namestring
OPTIONAL

The display name of the user.

For privacy reasons, this field is redacted for users outside of your organization. Rarely, it may also be unavailable for technical reasons.

emailstring
OPTIONAL

The email address of the user.

For privacy reasons, this field is redacted for users outside of your organization. Rarely, it may also be unavailable for technical reasons.

old_accessDesignAccessLevel
CONDITIONAL

Whether the design's content can be viewed or edited.

Properties of old_access
readboolean

Whether read access has been provided (true) or denied (false).

writeboolean

Whether write access has been provided (true) or denied (false).

commentboolean
OPTIONAL

Whether comment access has been provided (true) or denied (false).

new_accessDesignAccessLevel
CONDITIONAL

Whether the design's content can be viewed or edited.

Properties of new_access
readboolean

Whether read access has been provided (true) or denied (false).

writeboolean

Whether write access has been provided (true) or denied (false).

commentboolean
OPTIONAL

Whether comment access has been provided (true) or denied (false).

groupstring
CONDITIONAL

The Canva group affected by the access change.

teamAuditLogTeam
CONDITIONAL

A Canva team.

Properties of team
idstring

The team ID.

display_namestring
OPTIONAL

The display name of the team.

For privacy reasons, this field is redacted for brands outside of your organization. Rarely, it may be unavailable for technical reasons.

organizationAuditLogOrganization
CONDITIONAL

A Canva organization.

Properties of organization
idstring

The organization ID.

display_namestring
OPTIONAL

The display name of the organization.

For privacy reasons, this field is redacted for organizations other than your organization. Rarely, it may be unavailable for technical reasons.

owning_team_onlyboolean
CONDITIONAL

Only users in the same team as the design's owner can access the design.

If owning_team_only is false, anyone with the link can access the design.

old_link_roleDesignLinkRole
CONDITIONAL

How the design may be accessed using a collaboration link⁠(opens in a new tab or window).

Properties of old_link_role
accessDesignAccessLevel

Whether the design's content can be viewed or edited.

Properties of access
readboolean

Whether read access has been provided (true) or denied (false).

writeboolean

Whether write access has been provided (true) or denied (false).

commentboolean
OPTIONAL

Whether comment access has been provided (true) or denied (false).

owning_team_onlyboolean

Only users in the same team as the design's owner can access the design.

If owning_team_only is false, anyone with the link can access the design.

new_link_roleDesignLinkRole
CONDITIONAL

How the design may be accessed using a collaboration link⁠(opens in a new tab or window).

Properties of new_link_role
accessDesignAccessLevel

Whether the design's content can be viewed or edited.

Properties of access
readboolean

Whether read access has been provided (true) or denied (false).

writeboolean

Whether write access has been provided (true) or denied (false).

commentboolean
OPTIONAL

Whether comment access has been provided (true) or denied (false).

owning_team_onlyboolean

Only users in the same team as the design's owner can access the design.

If owning_team_only is false, anyone with the link can access the design.

Example

{
  "id": ...,
  "timestamp": ...,
  "actor": ...,
  "target": ...,
  "action": {
    "type": "UPDATE_DESIGN_ACCESS_CONTROLS",
    "changes": [
      {
        "type": "CREATE_DESIGN_ACCESS_TOKEN",
        "token_prefix": "ZMrbBHL2",
        "access": {
          "read": true,
          "write": true,
          "comment": true
        }
      },
      {
        "type": "DELETE_DESIGN_ACCESS_TOKEN",
        "token_prefix": "ZMrbBHL2",
        "access": {
          "read": true,
          "write": true,
          "comment": true
        }
      },
      {
        "type": "CREATE_DESIGN_ACCESS_INVITE",
        "token_prefix": "ZMrbBHL2",
        "recipient": "[email protected]",
        "access": {
          "read": true,
          "write": true,
          "comment": true
        }
      },
      {
        "type": "REDEEM_DESIGN_ACCESS_INVITE",
        "token_prefix": "ZMrbBHL2",
        "recipient": "[email protected]",
        "user": {
          "id": "UXoqDbwwSbQ",
          "display_name": "Jane Doe",
          "email": "[email protected]"
        }
      },
      {
        "type": "DELETE_DESIGN_ACCESS_INVITE",
        "token_prefix": "ZMrbBHL2",
        "recipient": "[email protected]"
      },
      {
        "type": "UPDATE_DESIGN_OWNER",
        "old_owner": {
          "id": "UXoqDbwwSbQ",
          "display_name": "Jane Doe",
          "email": "[email protected]"
        },
        "new_owner": {
          "id": "UXqwwoQDSbb",
          "display_name": "Ash Doe",
          "email": "[email protected]"
        }
      },
      {
        "type": "CREATE_DESIGN_ACCESS_RESTRICTION"
      },
      {
        "type": "DELETE_DESIGN_ACCESS_RESTRICTION"
      },
      {
        "type": "GRANT_USER_DESIGN_ACCESS",
        "access": {
          "read": true,
          "write": true,
          "comment": true
        },
        "user": {
          "id": "UXoqDbwwSbQ",
          "display_name": "Jane Doe",
          "email": "[email protected]"
        }
      },
      {
        "type": "REVOKE_USER_DESIGN_ACCESS",
        "access": {
          "read": true,
          "write": true,
          "comment": true
        },
        "user": {
          "id": "UXoqDbwwSbQ",
          "display_name": "Jane Doe",
          "email": "[email protected]"
        }
      },
      {
        "type": "UPDATE_USER_DESIGN_ACCESS",
        "old_access": {
          "read": true,
          "write": false
        },
        "new_access": {
          "read": true,
          "write": true
        },
        "user": {
          "id": "UXoqDbwwSbQ",
          "display_name": "Jane Doe",
          "email": "[email protected]"
        }
      },
      {
        "type": "GRANT_GROUP_DESIGN_ACCESS",
        "access": {
          "read": true,
          "write": true,
          "comment": true
        },
        "group": "GADkBZ48E04"
      },
      {
        "type": "REVOKE_GROUP_DESIGN_ACCESS",
        "access": {
          "read": true,
          "write": true,
          "comment": true
        },
        "group": "GADkBZ48E04"
      },
      {
        "type": "UPDATE_GROUP_DESIGN_ACCESS",
        "old_access": {
          "read": true,
          "write": false
        },
        "new_access": {
          "read": true,
          "write": true
        },
        "group": "GADkBZ48E04"
      },
      {
        "type": "GRANT_TEAM_DESIGN_ACCESS",
        "access": {
          "read": true,
          "write": true,
          "comment": true
        },
        "team": {
          "id": "BXeFatjDhdR",
          "display_name": "Acme Team"
        }
      },
      {
        "type": "REVOKE_TEAM_DESIGN_ACCESS",
        "access": {
          "read": true,
          "write": true,
          "comment": true
        },
        "team": {
          "id": "BXeFatjDhdR",
          "display_name": "Acme Team"
        }
      },
      {
        "type": "UPDATE_TEAM_DESIGN_ACCESS",
        "old_access": {
          "read": true,
          "write": false
        },
        "new_access": {
          "read": true,
          "write": true
        },
        "team": {
          "id": "BXeFatjDhdR",
          "display_name": "Acme Corporation"
        }
      },
      {
        "type": "GRANT_ORGANIZATION_DESIGN_ACCESS",
        "access": {
          "read": true,
          "write": true,
          "comment": true
        },
        "organization": {
          "id": "OXtgecafZvh",
          "display_name": "Acme Corporation"
        }
      },
      {
        "type": "REVOKE_ORGANIZATION_DESIGN_ACCESS",
        "access": {
          "read": true,
          "write": true,
          "comment": true
        },
        "organization": {
          "id": "OXtgecafZvh",
          "display_name": "Acme Corporation"
        }
      },
      {
        "type": "UPDATE_ORGANIZATION_DESIGN_ACCESS",
        "old_access": {
          "read": true,
          "write": false
        },
        "new_access": {
          "read": true,
          "write": true
        },
        "organization": {
          "id": "OXtgecafZvh"
        }
      },
      {
        "type": "GRANT_DESIGN_LINK_ACCESS",
        "access": {
          "read": true,
          "write": true,
          "comment": true
        },
        "owning_team_only": true
      },
      {
        "type": "REVOKE_DESIGN_LINK_ACCESS",
        "access": {
          "read": true,
          "write": true,
          "comment": true
        },
        "owning_team_only": true
      },
      {
        "type": "UPDATE_DESIGN_LINK_ACCESS",
        "old_link_role": {
          "access": {
            "read": true,
            "write": false
          },
          "owning_team_only": true
        },
        "new_link_role": {
          "access": {
            "read": true,
            "write": true
          },
          "owning_team_only": false
        }
      }
    ]
  },
  "outcome": ...,
  "context": ...
}
JSON

Send a design share notification

An actor triggers this event when they share a design. Canva will attempt to send an email and an in-app notification to the user the design is shared with (recipient).

typestring

Default value: SEND_DESIGN_SHARE_NOTIFICATION

Available values: The only valid value is SEND_DESIGN_SHARE_NOTIFICATION.

recipientShareNotificationRecipient

The recipient of the share notification.

The recipient can be a user, a group, an organization, or an email address.

Properties of recipient
typestring

This can be one of the following:

  • USER_RECIPIENT
  • GROUP_RECIPIENT
  • ORGANIZATION_RECIPIENT
  • EMAIL_RECIPIENT
userAuditLogUser
CONDITIONAL

A Canva user.

Properties of user
idstring

The user ID.

display_namestring
OPTIONAL

The display name of the user.

For privacy reasons, this field is redacted for users outside of your organization. Rarely, it may also be unavailable for technical reasons.

emailstring
OPTIONAL

The email address of the user.

For privacy reasons, this field is redacted for users outside of your organization. Rarely, it may also be unavailable for technical reasons.

groupAuditLogGroup
CONDITIONAL

A Canva group.

Properties of group
idstring

The group ID.

display_namestring
OPTIONAL

The display name of the group.

organizationAuditLogOrganization
CONDITIONAL

A Canva organization.

Properties of organization
idstring

The organization ID.

display_namestring
OPTIONAL

The display name of the organization.

For privacy reasons, this field is redacted for organizations other than your organization. Rarely, it may be unavailable for technical reasons.

emailstring
CONDITIONAL

The email address the design invite was sent to.

invite_to_teamboolean

Whether the recipient was invited to the team containing the shared design.

messagestring
OPTIONAL

An optional message from the actor to the recipient.

Example

{
  "id": ...,
  "timestamp": ...,
  "actor": ...,
  "target": ...,
  "action": {
    "type": "SEND_DESIGN_SHARE_NOTIFICATION",
    "message": "Check out my design!",
    "recipient": {
      "type": "USER_RECIPIENT",
      "user": {
        "id": "UXoqDbwwSbQ",
        "display_name": "Jane Doe",
        "email": "[email protected]"
      }
    },
    "invite_to_team": false
  },
  "outcome": ...,
  "context": ...
}
JSON

Request access to a design

An actor triggers this event when they request access to a design.

typestring

Default value: REQUEST_DESIGN_ACCESS

Available values: The only valid value is REQUEST_DESIGN_ACCESS.

ownerAuditLogUser

A Canva user.

Properties of owner
idstring

The user ID.

display_namestring
OPTIONAL

The display name of the user.

For privacy reasons, this field is redacted for users outside of your organization. Rarely, it may also be unavailable for technical reasons.

emailstring
OPTIONAL

The email address of the user.

For privacy reasons, this field is redacted for users outside of your organization. Rarely, it may also be unavailable for technical reasons.

Example

{
  "id": ...,
  "timestamp": ...,
  "actor": ...,
  "target": ...,
  "action": {
    "type": "REQUEST_DESIGN_ACCESS",
    "owner": {
      "id": "UXoqDbwwSbQ",
      "display_name": "Jane Doe",
      "email": "[email protected]"
    }
  },
  "outcome": ...,
  "context": ...
}
JSON

Grant access to a design

An actor triggers this event when they grant the requester access to their design.

typestring

Default value: GRANT_DESIGN_ACCESS

Available values: The only valid value is GRANT_DESIGN_ACCESS.

requesterAuditLogUser

A Canva user.

Properties of requester
idstring

The user ID.

display_namestring
OPTIONAL

The display name of the user.

For privacy reasons, this field is redacted for users outside of your organization. Rarely, it may also be unavailable for technical reasons.

emailstring
OPTIONAL

The email address of the user.

For privacy reasons, this field is redacted for users outside of your organization. Rarely, it may also be unavailable for technical reasons.

accessstring

A user's access level for a design.

Available values:

  • VIEW: The user can view the design.
  • COMMENT: The user can view and comment on the design.
  • EDIT: The user can view, comment, edit, and modify access to the design.

Example

{
  "id": ...,
  "timestamp": ...,
  "actor": ...,
  "target": ...,
  "action": {
    "type": "GRANT_DESIGN_ACCESS",
    "requester": {
      "id": "UXoqDbwwSbQ",
      "display_name": "Jane Doe",
      "email": "[email protected]"
    },
    "access": "VIEW"
  },
  "outcome": ...,
  "context": ...
}
JSON