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.
reasonGroupMembershipChangeReason
Optional

The reason for the change.

This change was triggered by an provisioning policy.

typestring

Default value: PROVISIONING_POLICY

Available values: The only valid value is PROVISIONING_POLICY.

provisioning_policyAuditLogProvisioningPolicy
Optional

A Canva provisioning policy.

idstring

The provisioning policy ID.

namestring
Optional

The provisioning policy name.

Example

{
  "id": ...,
  "timestamp": ...,
  "actor": ...,
  "target": ...,
  "action": {
    "type": "ADD_USER_TO_GROUP",
    "user": {
      "id": "UXoqDbwwSbQ",
      "display_name": "Jane Doe",
      "email": "[email protected]"
    },
    "role": "MEMBER",
    "reason": {
      "type": "PROVISIONING_POLICY",
      "provisioning_policy": {
        "id": "eb4f7245-b082-4774-a3d6-6d64525a8657",
        "name": "My Provisioning Policy"
      }
    }
  },
  "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.
reasonGroupMembershipChangeReason
Optional

The reason for the change.

This change was triggered by an provisioning policy.

typestring

Default value: PROVISIONING_POLICY

Available values: The only valid value is PROVISIONING_POLICY.

provisioning_policyAuditLogProvisioningPolicy
Optional

A Canva provisioning policy.

idstring

The provisioning policy ID.

namestring
Optional

The provisioning policy name.

Example

{
  "id": ...,
  "timestamp": ...,
  "actor": ...,
  "target": ...,
  "action": {
    "type": "REMOVE_USER_FROM_GROUP",
    "user": {
      "id": "UXoqDbwwSbQ",
      "display_name": "Jane Doe",
      "email": "[email protected]"
    },
    "role": "MEMBER",
    "reason": {
      "type": "PROVISIONING_POLICY",
      "provisioning_policy": {
        "id": "eb4f7245-b082-4774-a3d6-6d64525a8657",
        "name": "My Provisioning Policy"
      }
    }
  },
  "outcome": ...,
  "context": ...
}
JSON

Send a group invitation

An actor triggers this event when they send an invitation to join a Canva group. The invitation is addressed to a user, an email address, or shared as a link.

typestring

Default value: CREATE_GROUP_INVITATION

Available values: The only valid value is CREATE_GROUP_INVITATION.

invitation_typeGroupInvitationType

How a user is invited to join a group. The invitation can be addressed to an email address, issued as a short-lived join code, or a shareable link.

A group invitation addressed to an email address.

typestring

Default value: EMAIL

Available values: The only valid value is EMAIL: Invite by an email..

emailstring

The email address invited to the group.

A group invitation issued as a short-lived join code.

typestring

Default value: CODE

Available values: The only valid value is CODE: Invite by a short-lived code..

A group invitation issued as a shareable join link.

typestring

Default value: LINK

Available values: The only valid value is LINK: Invite by a link..

rolestring

The user's role within a group.

Available values:

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

Example

{
  "id": ...,
  "timestamp": ...,
  "actor": ...,
  "target": ...,
  "action": {
    "type": "CREATE_GROUP_INVITATION",
    "invitation_type": {
      "type": "EMAIL",
      "email": "[email protected]"
    },
    "role": "MEMBER"
  },
  "outcome": ...,
  "context": ...
}
JSON

Resend a group invitation

An actor triggers this event when they resend a group invitation to an email address.

typestring

Default value: RESEND_GROUP_INVITATION

Available values: The only valid value is RESEND_GROUP_INVITATION.

invitation_typeGroupInvitationType

How a user is invited to join a group. The invitation can be addressed to an email address, issued as a short-lived join code, or a shareable link.

A group invitation addressed to an email address.

typestring

Default value: EMAIL

Available values: The only valid value is EMAIL: Invite by an email..

emailstring

The email address invited to the group.

A group invitation issued as a short-lived join code.

typestring

Default value: CODE

Available values: The only valid value is CODE: Invite by a short-lived code..

A group invitation issued as a shareable join link.

typestring

Default value: LINK

Available values: The only valid value is LINK: Invite by a link..

rolestring

The user's role within a group.

Available values:

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

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.

Example

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

Update a group invitation

An actor triggers this event when they change a pending group invitation, such as updating the invitee's role. The optional old_role field is the previous group role when the role was changed.

typestring

Default value: UPDATE_GROUP_INVITATION

Available values: The only valid value is UPDATE_GROUP_INVITATION.

invitation_typeGroupInvitationType

How a user is invited to join a group. The invitation can be addressed to an email address, issued as a short-lived join code, or a shareable link.

A group invitation addressed to an email address.

typestring

Default value: EMAIL

Available values: The only valid value is EMAIL: Invite by an email..

emailstring

The email address invited to the group.

A group invitation issued as a short-lived join code.

typestring

Default value: CODE

Available values: The only valid value is CODE: Invite by a short-lived code..

A group invitation issued as a shareable join link.

typestring

Default value: LINK

Available values: The only valid value is LINK: Invite by a link..

new_rolestring

The user's role within a group.

Available values:

  • MEMBER: Group member.
  • ADMIN: Group administrator.
changed_fieldsstring[]
Optional

Fields requested to be changed in this update.

Available values: The only valid value is ROLE: The group role..

old_rolestring
Optional

The user's role within a group.

Available values:

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

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.

Example

{
  "id": ...,
  "timestamp": ...,
  "actor": ...,
  "target": ...,
  "action": {
    "type": "UPDATE_GROUP_INVITATION",
    "changed_fields": [
      "ROLE"
    ],
    "invitation_type": {
      "type": "EMAIL",
      "email": "[email protected]"
    },
    "new_role": "MEMBER",
    "old_role": "MEMBER",
    "inviter": {
      "id": "UXoqDbwwSbQ",
      "display_name": "Jane Doe",
      "email": "[email protected]"
    }
  },
  "outcome": ...,
  "context": ...
}
JSON

Cancel a group invitation

An actor triggers this event when they cancel a pending group invitation. The invitation is identified by the invited user, an email address, or the invitation link.

typestring

Default value: DELETE_GROUP_INVITATION

Available values: The only valid value is DELETE_GROUP_INVITATION.

rolestring

The user's role within a group.

Available values:

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

How a user is invited to join a group. The invitation can be addressed to an email address, issued as a short-lived join code, or a shareable link.

A group invitation addressed to an email address.

typestring

Default value: EMAIL

Available values: The only valid value is EMAIL: Invite by an email..

emailstring

The email address invited to the group.

A group invitation issued as a short-lived join code.

typestring

Default value: CODE

Available values: The only valid value is CODE: Invite by a short-lived code..

A group invitation issued as a shareable join link.

typestring

Default value: LINK

Available values: The only valid value is LINK: Invite by a link..

inviterAuditLogUser
Optional

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.

Example

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

Accept a group invitation

An actor triggers this event when they accept a pending group invitation.

typestring

Default value: ACCEPT_GROUP_INVITATION

Available values: The only valid value is ACCEPT_GROUP_INVITATION.

invitation_typeGroupInvitationType

How a user is invited to join a group. The invitation can be addressed to an email address, issued as a short-lived join code, or a shareable link.

A group invitation addressed to an email address.

typestring

Default value: EMAIL

Available values: The only valid value is EMAIL: Invite by an email..

emailstring

The email address invited to the group.

A group invitation issued as a short-lived join code.

typestring

Default value: CODE

Available values: The only valid value is CODE: Invite by a short-lived code..

A group invitation issued as a shareable join link.

typestring

Default value: LINK

Available values: The only valid value is LINK: Invite by a link..

rolestring
Optional

The user's role within a group.

Available values:

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

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.

inviterAuditLogUser
Optional

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.

Example

{
  "id": ...,
  "timestamp": ...,
  "actor": ...,
  "target": ...,
  "action": {
    "type": "ACCEPT_GROUP_INVITATION",
    "invitation_type": {
      "type": "EMAIL",
      "email": "[email protected]"
    },
    "role": "MEMBER",
    "invitee": {
      "id": "UXoqDbwwSbQ",
      "display_name": "Jane Doe",
      "email": "[email protected]"
    },
    "inviter": {
      "id": "UXoqDbwwSbQ",
      "display_name": "Jane Doe",
      "email": "[email protected]"
    }
  },
  "outcome": ...,
  "context": ...
}
JSON