Skip navigation

Skip to main content

Groups

Create a 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

Default value: CREATE_GROUP

Available values: The only valid value is 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 a group's details

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

typestring

Default value: UPDATE_GROUP

Available values: The only valid value is 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 a group

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

typestring

Default value: DELETE_GROUP

Available values: The only valid value is DELETE_GROUP.

Example

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

Add a user to a 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

Default value: ADD_USER_TO_GROUP

Available values: The only valid value is ADD_USER_TO_GROUP.

userAuditLogUser

A Canva 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
Optional

The user's role within a group.

Available values:

  • 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 a user in a 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

Default value: UPDATE_USER_IN_GROUP

Available values: The only valid value is UPDATE_USER_IN_GROUP.

userAuditLogUser

A Canva 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.

Available values:

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

The user's role within a group.

Available values:

  • 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 a user from a 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

Default value: REMOVE_USER_FROM_GROUP

Available values: The only valid value is REMOVE_USER_FROM_GROUP.

userAuditLogUser

A Canva 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
Optional

The user's role within a group.

Available values:

  • 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]"
    },
    "role": "MEMBER"
  },
  "outcome": ...,
  "context": ...
}
JSON