Skip navigation

Skip to main content

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

Groups

Create group

An actor triggers this event when they create a new Canva group. For details on creating Canva groups, see Canva Help: Creating groups⁠(opens in a new tab or window).

typestring

The value for this can only be CREATE_GROUP.

display_namestring

The display name for the group.

descriptionstring
OPTIONAL

A description for the group.

Example

{
  "id": ...,
  "timestamp": ...,
  "actor": ...,
  "target": ...,
  "action": {
    "type": "CREATE_GROUP",
    "display_name": "Marketing",
    "description": "The Acme Corporation marketing group."
  },
  "outcome": ...,
  "context": ...
}
JSON

Update group

An actor triggers this event when they update the details of a Canva group, such as the group's display name.

typestring

The value for this can only be UPDATE_GROUP.

old_display_namestring
OPTIONAL

The old display name of the group.

new_display_namestring
OPTIONAL

The new display name for the group.

Example

{
  "id": ...,
  "timestamp": ...,
  "actor": ...,
  "target": ...,
  "action": {
    "type": "UPDATE_GROUP",
    "old_display_name": "Marketing",
    "new_display_name": "Growth"
  },
  "outcome": ...,
  "context": ...
}
JSON

Delete group

An actor triggers this event when they delete a Canva group.

typestring

The value for this can only be DELETE_GROUP.

Example

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

Add user to group

An actor triggers this event when they add a Canva user to a Canva group. For details on adding users to a Canva group, see Canva Help: Creating groups — Adding people to a group⁠(opens in a new tab or window).

typestring

The value for this can only be ADD_USER_TO_GROUP.

userAuditLogUser

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.

rolestring

The user's role within a group. This can be one of the following:

  • MEMBER: Group member.
  • ADMIN: Group administrator.

Example

{
  "id": ...,
  "timestamp": ...,
  "actor": ...,
  "target": ...,
  "action": {
    "type": "ADD_USER_TO_GROUP",
    "user": {
      "id": "UXoqDbwwSbQ",
      "display_name": "Jane Doe",
      "email": "[email protected]"
    },
    "role": "MEMBER"
  },
  "outcome": ...,
  "context": ...
}
JSON

Update user in group

An actor triggers this event when they update a Canva user's membership within a Canva group, such as changing the user's role from ADMIN to MEMBER.

typestring

The value for this can only be UPDATE_USER_IN_GROUP.

userAuditLogUser

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.

new_rolestring
OPTIONAL

The user's role within a group. This can be one of the following:

  • MEMBER: Group member.
  • ADMIN: Group administrator.
old_rolestring
OPTIONAL

The user's role within a group. This can be one of the following:

  • MEMBER: Group member.
  • ADMIN: Group administrator.

Example

{
  "id": ...,
  "timestamp": ...,
  "actor": ...,
  "target": ...,
  "action": {
    "type": "UPDATE_USER_IN_GROUP",
    "user": {
      "id": "UXoqDbwwSbQ",
      "display_name": "Jane Doe",
      "email": "[email protected]"
    },
    "new_role": "ADMIN",
    "old_role": "MEMBER"
  },
  "outcome": ...,
  "context": ...
}
JSON

Remove user from group

An actor triggers this event when they remove a Canva user from a Canva group. This includes users removing themselves from a group.

typestring

The value for this can only be REMOVE_USER_FROM_GROUP.

userAuditLogUser

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_rolestring

The user's role within a group. This can be one of the following:

  • MEMBER: Group member.
  • ADMIN: Group administrator.

Example

{
  "id": ...,
  "timestamp": ...,
  "actor": ...,
  "target": ...,
  "action": {
    "type": "REMOVE_USER_FROM_GROUP",
    "user": {
      "id": "UXoqDbwwSbQ",
      "display_name": "Jane Doe",
      "email": "[email protected]"
    },
    "old_role": "MEMBER"
  },
  "outcome": ...,
  "context": ...
}
JSON