Skip navigation

Skip to main content

Audio

Create an audio

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

typestring

Default value: CREATE_AUDIO

Available values: The only valid value is CREATE_AUDIO.

filenamestring
Optional

The name of the uploaded file.

Example

{
  "id": ...,
  "timestamp": ...,
  "actor": ...,
  "target": ...,
  "action": {
    "type": "CREATE_AUDIO",
    "filename": "theme.mp3"
  },
  "outcome": ...,
  "context": ...
}
JSON

Update an audio's details

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

typestring

Default value: UPDATE_AUDIO

Available values: The only valid value is UPDATE_AUDIO.

old_titlestring
Optional

The old title of the audio.

new_titlestring
Optional

The new title of the audio.

old_tagsstring[]
Optional

Original list of tags associated with the audio.

new_tagsstring[]
Optional

New list of tags associated with the audio.

changed_fieldsstring[]
Optional

Fields requested to be changed in this update.

Available values:

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

Example

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

Delete an audio

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

typestring

Default value: DELETE_AUDIO

Available values: The only valid value is DELETE_AUDIO.

Example

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

Trash an audio

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

typestring

Default value: TRASH_AUDIO

Available values: The only valid value is TRASH_AUDIO.

Example

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

Restore an audio from Trash

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

typestring

Default value: UNDELETE_AUDIO

Available values: The only valid value is UNDELETE_AUDIO.

Example

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

Copy an audio

An actor triggers this event when they copy an audio.

typestring

Default value: COPY_AUDIO

Available values: The only valid value is COPY_AUDIO.

Example

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

Update an audio's access controls

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

typestring

Default value: UPDATE_AUDIO_ACCESS_CONTROLS

Available values: The only valid value is UPDATE_AUDIO_ACCESS_CONTROLS.

changesAudioAccessControlListChange[]

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

A user granted another user access to the audio.

typestring

Default value: GRANT_USER_AUDIO_ACCESS

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

accessAudioAccessLevel

Access permissions for an audio 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 audio.

typestring

Default value: REVOKE_USER_AUDIO_ACCESS

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

typestring

Default value: UPDATE_USER_AUDIO_ACCESS

Available values: The only valid value is UPDATE_USER_AUDIO_ACCESS.

old_accessAudioAccessLevel

Access permissions for an audio 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_accessAudioAccessLevel

Access permissions for an audio 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 audio.

typestring

Default value: GRANT_GROUP_AUDIO_ACCESS

Available values: The only valid value is GRANT_GROUP_AUDIO_ACCESS.

groupAuditLogGroup

A Canva group.

idstring

The group ID.

display_namestring
Optional

The display name of the group.

accessAudioAccessLevel

Access permissions for an audio 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 audio.

typestring

Default value: REVOKE_GROUP_AUDIO_ACCESS

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

typestring

Default value: UPDATE_GROUP_AUDIO_ACCESS

Available values: The only valid value is UPDATE_GROUP_AUDIO_ACCESS.

old_accessAudioAccessLevel

Access permissions for an audio 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_accessAudioAccessLevel

Access permissions for an audio 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 audio.

typestring

Default value: GRANT_TEAM_AUDIO_ACCESS

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

accessAudioAccessLevel

Access permissions for an audio 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 audio.

typestring

Default value: REVOKE_TEAM_AUDIO_ACCESS

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

typestring

Default value: UPDATE_TEAM_AUDIO_ACCESS

Available values: The only valid value is UPDATE_TEAM_AUDIO_ACCESS.

old_accessAudioAccessLevel

Access permissions for an audio 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_accessAudioAccessLevel

Access permissions for an audio 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 audio.

typestring

Default value: GRANT_ORGANIZATION_AUDIO_ACCESS

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

accessAudioAccessLevel

Access permissions for an audio 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 audio.

typestring

Default value: REVOKE_ORGANIZATION_AUDIO_ACCESS

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

typestring

Default value: UPDATE_ORGANIZATION_AUDIO_ACCESS

Available values: The only valid value is UPDATE_ORGANIZATION_AUDIO_ACCESS.

old_accessAudioAccessLevel

Access permissions for an audio 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_accessAudioAccessLevel

Access permissions for an audio 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 audio asset was changed.

typestring

Default value: UPDATE_AUDIO_OWNER

Available values: The only valid value is UPDATE_AUDIO_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_AUDIO_ACCESS_CONTROLS",
    "changes": [
      {
        "type": "GRANT_USER_AUDIO_ACCESS",
        "user": {
          "id": "UXoqDbwwSbQ",
          "display_name": "Jane Doe",
          "email": "[email protected]"
        },
        "access": {
          "read": false,
          "write": false
        }
      },
      {
        "type": "REVOKE_USER_AUDIO_ACCESS",
        "user": {
          "id": "UXoqDbwwSbQ",
          "display_name": "Jane Doe",
          "email": "[email protected]"
        }
      },
      {
        "type": "UPDATE_USER_AUDIO_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_AUDIO_ACCESS",
        "group": {
          "id": "GJViWaMsqhL",
          "display_name": "Marketing Group"
        },
        "access": {
          "read": false,
          "write": false
        }
      },
      {
        "type": "REVOKE_GROUP_AUDIO_ACCESS",
        "group": {
          "id": "GJViWaMsqhL",
          "display_name": "Marketing Group"
        }
      },
      {
        "type": "UPDATE_GROUP_AUDIO_ACCESS",
        "old_access": {
          "read": false,
          "write": false
        },
        "new_access": {
          "read": false,
          "write": false
        },
        "group": {
          "id": "GJViWaMsqhL",
          "display_name": "Marketing Group"
        }
      },
      {
        "type": "GRANT_TEAM_AUDIO_ACCESS",
        "team": {
          "id": "BXeFatjDhdR",
          "display_name": "Acme Team"
        },
        "access": {
          "read": false,
          "write": false
        }
      },
      {
        "type": "REVOKE_TEAM_AUDIO_ACCESS",
        "team": {
          "id": "BXeFatjDhdR",
          "display_name": "Acme Team"
        }
      },
      {
        "type": "UPDATE_TEAM_AUDIO_ACCESS",
        "old_access": {
          "read": false,
          "write": false
        },
        "new_access": {
          "read": false,
          "write": false
        },
        "team": {
          "id": "BXeFatjDhdR",
          "display_name": "Acme Team"
        }
      },
      {
        "type": "GRANT_ORGANIZATION_AUDIO_ACCESS",
        "organization": {
          "id": "OXtgecafZvh",
          "display_name": "Acme Corporation"
        },
        "access": {
          "read": false,
          "write": false
        }
      },
      {
        "type": "REVOKE_ORGANIZATION_AUDIO_ACCESS",
        "organization": {
          "id": "OXtgecafZvh",
          "display_name": "Acme Corporation"
        }
      },
      {
        "type": "UPDATE_ORGANIZATION_AUDIO_ACCESS",
        "old_access": {
          "read": false,
          "write": false
        },
        "new_access": {
          "read": false,
          "write": false
        },
        "organization": {
          "id": "OXtgecafZvh",
          "display_name": "Acme Corporation"
        }
      },
      {
        "type": "UPDATE_AUDIO_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