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).
type
string
Default value: CREATE_GROUP
Available values: The only valid value is CREATE_GROUP
.
display_name
string
The display name for the group.
description
string
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": ...}
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.
type
string
Default value: UPDATE_GROUP
Available values: The only valid value is UPDATE_GROUP
.
old_display_name
string
The old display name of the group.
new_display_name
string
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": ...}
Delete a group
An actor
triggers this event when they delete a
Canva group.
type
string
Default value: DELETE_GROUP
Available values: The only valid value is DELETE_GROUP
.
Example
{"id": ...,"timestamp": ...,"actor": ...,"target": ...,"action": {"type": "DELETE_GROUP"},"outcome": ...,"context": ...}
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).
type
string
Default value: ADD_USER_TO_GROUP
Available values: The only valid value is ADD_USER_TO_GROUP
.
user
AuditLogUser
A Canva user.
Properties of user
id
string
The user ID.
display_name
string
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.
email
string
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.
role
string
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",},"role": "MEMBER"},"outcome": ...,"context": ...}
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
.
type
string
Default value: UPDATE_USER_IN_GROUP
Available values: The only valid value is UPDATE_USER_IN_GROUP
.
user
AuditLogUser
A Canva user.
Properties of user
id
string
The user ID.
display_name
string
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.
email
string
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_role
string
The user's role within a group.
Available values:
MEMBER
: Group member.ADMIN
: Group administrator.
old_role
string
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",},"new_role": "ADMIN","old_role": "MEMBER"},"outcome": ...,"context": ...}
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.
type
string
Default value: REMOVE_USER_FROM_GROUP
Available values: The only valid value is REMOVE_USER_FROM_GROUP
.
user
AuditLogUser
A Canva user.
Properties of user
id
string
The user ID.
display_name
string
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.
email
string
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_role
string
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",},"old_role": "MEMBER"},"outcome": ...,"context": ...}