Skip navigation

Skip to main content

Videos

Create a video

An actor triggers this event when they create/upload a video to their account or team.

typestring

Default value: CREATE_VIDEO

Available values: The only valid value is CREATE_VIDEO.

filenamestring
Optional

The name of the uploaded file.

Example

{
  "id": ...,
  "timestamp": ...,
  "actor": ...,
  "target": ...,
  "action": {
    "type": "CREATE_VIDEO",
    "filename": "company_logo.jpg"
  },
  "outcome": ...,
  "context": ...
}
JSON

Update a video's details

An actor triggers this event when they update videos in their account or team.

typestring

Default value: UPDATE_VIDEO

Available values: The only valid value is UPDATE_VIDEO.

old_titlestring
Optional

The old title of the video.

new_titlestring
Optional

The new title of the video.

old_tagsstring[]
Optional

Original list of tags associated with the video.

new_tagsstring[]
Optional

New list of tags associated with the video.

changed_fieldsstring[]
Optional

Fields requested to be changed in this update.

Available values:

  • TITLE: The video's title.
  • TAGS: The video's tags.

Example

{
  "id": ...,
  "timestamp": ...,
  "actor": ...,
  "target": ...,
  "action": {
    "type": "UPDATE_VIDEO",
    "old_title": "Original Company Logo",
    "new_title": "New Company Logo",
    "old_tags": [
      "logo"
    ],
    "new_tags": [
      "logo",
      "branding"
    ],
    "changed_fields": [
      "TITLE",
      "TAGS"
    ]
  },
  "outcome": ...,
  "context": ...
}
JSON

Delete a video

An actor triggers this event when they permanently delete videos from their account or team.

typestring

Default value: DELETE_VIDEO

Available values: The only valid value is DELETE_VIDEO.

Example

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

Trash a video

An actor triggers this event when they move videos to the trash folder. Videos in the trash folder aren't accessible to collaborators and will be deleted after a period of time.

typestring

Default value: TRASH_VIDEO

Available values: The only valid value is TRASH_VIDEO.

Example

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

Restore a video from Trash

An actor triggers this event when they restore videos from the trash folder.

typestring

Default value: UNDELETE_VIDEO

Available values: The only valid value is UNDELETE_VIDEO.

Example

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

Copy a video

An actor triggers this event when they copy a video.

typestring

Default value: COPY_VIDEO

Available values: The only valid value is COPY_VIDEO.

Example

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

Update a video's access controls

An actor triggers this event when they change the rules that control access to a video asset. There can be multiple changes in a single update.

typestring

Default value: UPDATE_VIDEO_ACCESS_CONTROLS

Available values: The only valid value is UPDATE_VIDEO_ACCESS_CONTROLS.

changesVideoAccessControlListChange[]

A change to the rules that control the access to the video asset.

A user granted another user access to the video.

typestring

Default value: GRANT_USER_VIDEO_ACCESS

Available values: The only valid value is GRANT_USER_VIDEO_ACCESS.

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.

accessVideoAccessLevel

Access permissions for a video asset.

readboolean

Whether read access has been provided (true) or denied (false).

Default value: false

writeboolean

Whether write access has been provided (true) or denied (false).

Default value: false

A user revoked another user's access to the video.

typestring

Default value: REVOKE_USER_VIDEO_ACCESS

Available values: The only valid value is REVOKE_USER_VIDEO_ACCESS.

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.

A user changed another user's access to the video.

typestring

Default value: UPDATE_USER_VIDEO_ACCESS

Available values: The only valid value is UPDATE_USER_VIDEO_ACCESS.

old_accessVideoAccessLevel

Access permissions for a video asset.

readboolean

Whether read access has been provided (true) or denied (false).

Default value: false

writeboolean

Whether write access has been provided (true) or denied (false).

Default value: false

new_accessVideoAccessLevel

Access permissions for a video asset.

readboolean

Whether read access has been provided (true) or denied (false).

Default value: false

writeboolean

Whether write access has been provided (true) or denied (false).

Default value: false

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.

A user granted a group⁠(opens in a new tab or window) access to the video.

typestring

Default value: GRANT_GROUP_VIDEO_ACCESS

Available values: The only valid value is GRANT_GROUP_VIDEO_ACCESS.

groupAuditLogGroup

A Canva group.

idstring

The group ID.

display_namestring
Optional

The display name of the group.

accessVideoAccessLevel

Access permissions for a video asset.

readboolean

Whether read access has been provided (true) or denied (false).

Default value: false

writeboolean

Whether write access has been provided (true) or denied (false).

Default value: false

A user revoked a group's⁠(opens in a new tab or window) access to the video.

typestring

Default value: REVOKE_GROUP_VIDEO_ACCESS

Available values: The only valid value is REVOKE_GROUP_VIDEO_ACCESS.

groupAuditLogGroup

A Canva group.

idstring

The group ID.

display_namestring
Optional

The display name of the group.

A user changed a group's⁠(opens in a new tab or window) access to the video.

typestring

Default value: UPDATE_GROUP_VIDEO_ACCESS

Available values: The only valid value is UPDATE_GROUP_VIDEO_ACCESS.

old_accessVideoAccessLevel

Access permissions for a video asset.

readboolean

Whether read access has been provided (true) or denied (false).

Default value: false

writeboolean

Whether write access has been provided (true) or denied (false).

Default value: false

new_accessVideoAccessLevel

Access permissions for a video asset.

readboolean

Whether read access has been provided (true) or denied (false).

Default value: false

writeboolean

Whether write access has been provided (true) or denied (false).

Default value: false

groupAuditLogGroup

A Canva group.

idstring

The group ID.

display_namestring
Optional

The display name of the group.

A user granted a team⁠(opens in a new tab or window) access to the video.

typestring

Default value: GRANT_TEAM_VIDEO_ACCESS

Available values: The only valid value is GRANT_TEAM_VIDEO_ACCESS.

teamAuditLogTeam

A Canva team.

idstring

The team ID.

display_namestring
Optional

The display name of the team.

For privacy reasons, this field is redacted for brands outside of your organization. Rarely, it may be unavailable for technical reasons.

accessVideoAccessLevel

Access permissions for a video asset.

readboolean

Whether read access has been provided (true) or denied (false).

Default value: false

writeboolean

Whether write access has been provided (true) or denied (false).

Default value: false

A user revoked a team's⁠(opens in a new tab or window) access to the video.

typestring

Default value: REVOKE_TEAM_VIDEO_ACCESS

Available values: The only valid value is REVOKE_TEAM_VIDEO_ACCESS.

teamAuditLogTeam

A Canva team.

idstring

The team ID.

display_namestring
Optional

The display name of the team.

For privacy reasons, this field is redacted for brands outside of your organization. Rarely, it may be unavailable for technical reasons.

A user changed a team's⁠(opens in a new tab or window) access to the video.

typestring

Default value: UPDATE_TEAM_VIDEO_ACCESS

Available values: The only valid value is UPDATE_TEAM_VIDEO_ACCESS.

old_accessVideoAccessLevel

Access permissions for a video asset.

readboolean

Whether read access has been provided (true) or denied (false).

Default value: false

writeboolean

Whether write access has been provided (true) or denied (false).

Default value: false

new_accessVideoAccessLevel

Access permissions for a video asset.

readboolean

Whether read access has been provided (true) or denied (false).

Default value: false

writeboolean

Whether write access has been provided (true) or denied (false).

Default value: false

teamAuditLogTeam

A Canva team.

idstring

The team ID.

display_namestring
Optional

The display name of the team.

For privacy reasons, this field is redacted for brands outside of your organization. Rarely, it may be unavailable for technical reasons.

A user granted an organization access to the video.

typestring

Default value: GRANT_ORGANIZATION_VIDEO_ACCESS

Available values: The only valid value is GRANT_ORGANIZATION_VIDEO_ACCESS.

organizationAuditLogOrganization

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

accessVideoAccessLevel

Access permissions for a video asset.

readboolean

Whether read access has been provided (true) or denied (false).

Default value: false

writeboolean

Whether write access has been provided (true) or denied (false).

Default value: false

A user revoked an organization's access to the video.

typestring

Default value: REVOKE_ORGANIZATION_VIDEO_ACCESS

Available values: The only valid value is REVOKE_ORGANIZATION_VIDEO_ACCESS.

organizationAuditLogOrganization

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

A user changed an organization's access to the video.

typestring

Default value: UPDATE_ORGANIZATION_VIDEO_ACCESS

Available values: The only valid value is UPDATE_ORGANIZATION_VIDEO_ACCESS.

old_accessVideoAccessLevel

Access permissions for a video asset.

readboolean

Whether read access has been provided (true) or denied (false).

Default value: false

writeboolean

Whether write access has been provided (true) or denied (false).

Default value: false

new_accessVideoAccessLevel

Access permissions for a video asset.

readboolean

Whether read access has been provided (true) or denied (false).

Default value: false

writeboolean

Whether write access has been provided (true) or denied (false).

Default value: false

organizationAuditLogOrganization

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

The owner of the video asset was changed.

typestring

Default value: UPDATE_VIDEO_OWNER

Available values: The only valid value is UPDATE_VIDEO_OWNER.

old_ownerAuditLogUser
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.

new_ownerAuditLogUser
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_VIDEO_ACCESS_CONTROLS",
    "changes": [
      {
        "type": "GRANT_USER_VIDEO_ACCESS",
        "user": {
          "id": "UXoqDbwwSbQ",
          "display_name": "Jane Doe",
          "email": "[email protected]"
        },
        "access": {
          "read": false,
          "write": false
        }
      },
      {
        "type": "REVOKE_USER_VIDEO_ACCESS",
        "user": {
          "id": "UXoqDbwwSbQ",
          "display_name": "Jane Doe",
          "email": "[email protected]"
        }
      },
      {
        "type": "UPDATE_USER_VIDEO_ACCESS",
        "old_access": {
          "read": false,
          "write": false
        },
        "new_access": {
          "read": false,
          "write": false
        },
        "user": {
          "id": "UXoqDbwwSbQ",
          "display_name": "Jane Doe",
          "email": "[email protected]"
        }
      },
      {
        "type": "GRANT_GROUP_VIDEO_ACCESS",
        "group": {
          "id": "GJViWaMsqhL",
          "display_name": "Marketing Group"
        },
        "access": {
          "read": false,
          "write": false
        }
      },
      {
        "type": "REVOKE_GROUP_VIDEO_ACCESS",
        "group": {
          "id": "GJViWaMsqhL",
          "display_name": "Marketing Group"
        }
      },
      {
        "type": "UPDATE_GROUP_VIDEO_ACCESS",
        "old_access": {
          "read": false,
          "write": false
        },
        "new_access": {
          "read": false,
          "write": false
        },
        "group": {
          "id": "GJViWaMsqhL",
          "display_name": "Marketing Group"
        }
      },
      {
        "type": "GRANT_TEAM_VIDEO_ACCESS",
        "team": {
          "id": "BXeFatjDhdR",
          "display_name": "Acme Team"
        },
        "access": {
          "read": false,
          "write": false
        }
      },
      {
        "type": "REVOKE_TEAM_VIDEO_ACCESS",
        "team": {
          "id": "BXeFatjDhdR",
          "display_name": "Acme Team"
        }
      },
      {
        "type": "UPDATE_TEAM_VIDEO_ACCESS",
        "old_access": {
          "read": false,
          "write": false
        },
        "new_access": {
          "read": false,
          "write": false
        },
        "team": {
          "id": "BXeFatjDhdR",
          "display_name": "Acme Team"
        }
      },
      {
        "type": "GRANT_ORGANIZATION_VIDEO_ACCESS",
        "organization": {
          "id": "OXtgecafZvh",
          "display_name": "Acme Corporation"
        },
        "access": {
          "read": false,
          "write": false
        }
      },
      {
        "type": "REVOKE_ORGANIZATION_VIDEO_ACCESS",
        "organization": {
          "id": "OXtgecafZvh",
          "display_name": "Acme Corporation"
        }
      },
      {
        "type": "UPDATE_ORGANIZATION_VIDEO_ACCESS",
        "old_access": {
          "read": false,
          "write": false
        },
        "new_access": {
          "read": false,
          "write": false
        },
        "organization": {
          "id": "OXtgecafZvh",
          "display_name": "Acme Corporation"
        }
      },
      {
        "type": "UPDATE_VIDEO_OWNER",
        "old_owner": {
          "id": "UXoqDbwwSbQ",
          "display_name": "Jane Doe",
          "email": "[email protected]"
        },
        "new_owner": {
          "id": "UXoqDbwwSbQ",
          "display_name": "Jane Doe",
          "email": "[email protected]"
        }
      }
    ]
  },
  "outcome": ...,
  "context": ...
}
JSON