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

Brands

Send a brand template share notification

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

typestring

Default value: SEND_BRAND_TEMPLATE_SHARE_NOTIFICATION

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

messagestring
OPTIONAL

An optional message from the actor to the recipient.

Example

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