Skip navigation

Skip to main content

Websites

Create a website domain

An actor triggers this event when they register a new domain for their website. For information on Canva websites, visit these Canva Help Center articles:

typestring

Default value: CREATE_WEBSITE_DOMAIN

Available values: The only valid value is CREATE_WEBSITE_DOMAIN.

namestring

The domain name (subdomain and the top-level domain).

domain_typestring
Optional

The type of domain being created.

Available values:

Example

{
  "id": ...,
  "timestamp": ...,
  "actor": ...,
  "target": ...,
  "action": {
    "type": "CREATE_WEBSITE_DOMAIN",
    "domain_type": "FREE",
    "name": "example.com"
  },
  "outcome": ...,
  "context": ...
}
JSON

Update a website domain's details

An actor triggers this event when they modify the data associated with an existing domain.

typestring

Default value: UPDATE_WEBSITE_DOMAIN

Available values: The only valid value is UPDATE_WEBSITE_DOMAIN.

update_typestring
Optional

Available values:

  • RENEW: Renew a previously purchased domain name registration for an additional period.
  • REDEEM: Redeem an expired domain name before it enters the redemption grace period.
  • RENAME: Rename a domain to a new public domain, including the website deployed to the current domain.
  • CONNECT_TO_CANVA: Connect a domain to Canva for hosting content.
  • DISCONNECT_FROM_CANVA: Disconnect a domain from Canva to host content on a different platform.
  • TRANSFER_DOMAIN: Unlock a purchased domain and initiate transfer of domain ownership to a different registrar.
  • CANCEL_TRANSFER: Cancel an in-progress domain transfer.
  • UPDATE_DNS_RECORDS: Update DNS records for the domain.
  • UPDATE_NAMESERVERS: Update the nameserver records for the domain.
  • RESET_NAMESERVERS: Reset the nameserver records for the domain to their default.
  • UPDATE_CONTACT: Update contact information for the domain.
old_domain_namestring
Optional

The old domain name (shown when the update_type is RENAME)

new_domain_namestring
Optional

The new domain name (shown when the update_type is RENAME)

old_dns_recordsDnsRecord[]
Optional

The old DNS records (shown when the update_type is either UPDATE_DNS_RECORDS or RESET_NAMESERVERS).

namestring

The record name.

typestring

The record type.

Available values:

  • A: IPv4 address record.
  • AAAA: IPv6 address record.
  • CNAME: Canonical name record.
  • MX: Mail exchange record.
  • TXT: Text record.
  • NS: Nameserver record.
  • SRV: Service record.
  • CAA: Certificate Authority Authorization record.
valuestring

The record value.

new_dns_recordsDnsRecord[]
Optional

The new custom DNS records (shown when the update_type is either UPDATE_DNS_RECORDS or RESET_NAMESERVERS).

namestring

The record name.

typestring

The record type.

Available values:

  • A: IPv4 address record.
  • AAAA: IPv6 address record.
  • CNAME: Canonical name record.
  • MX: Mail exchange record.
  • TXT: Text record.
  • NS: Nameserver record.
  • SRV: Service record.
  • CAA: Certificate Authority Authorization record.
valuestring

The record value.

new_contact_infoContactInfo
Optional

The contact information for a domain owner.

namestring

The combined first and last name of the owner.

emailstring

The owner's email address.

phonestring

The owner's phone number.

addressstring

The street and number of the owner's address.

citystring

The city in the owner's address.

countrystring

The two-letter ISO country code representing the country in the owner's address.

organization_namestring
Optional

The name of the organization that owns the domain.

postcodestring
Optional

The postal code in the owner's address.

statestring
Optional

The state of the owner's address.

languagestring
Optional

Language used for messaging the owner.

Example

{
  "id": ...,
  "timestamp": ...,
  "actor": ...,
  "target": ...,
  "action": {
    "type": "UPDATE_WEBSITE_DOMAIN",
    "update_type": "RENEW",
    "old_domain_name": "old-example.com",
    "new_domain_name": "new-example.com",
    "old_dns_records": [
      {
        "name": "example.com",
        "type": "A",
        "value": "192.168.0.1"
      },
      {
        "name": "example.com",
        "type": "CNAME",
        "value": "subdomain.example.com"
      }
    ],
    "new_dns_records": [
      {
        "name": "example.com",
        "type": "A",
        "value": "192.168.0.12"
      },
      {
        "name": "example.com",
        "type": "CNAME",
        "value": "subdomain.example.com"
      }
    ],
    "new_contact_info": {
      "name": "John Doe",
      "email": "[email protected]",
      "organization_name": "Acme Corporation",
      "phone": "+1-555-555-5555",
      "address": "123 Main St",
      "postcode": "78701",
      "state": "Texas",
      "city": "Austin",
      "country": "US",
      "language": "en"
    }
  },
  "outcome": ...,
  "context": ...
}
JSON

Delete a website domain

An actor triggers this event when they delete a domain.

typestring

Default value: DELETE_WEBSITE_DOMAIN

Available values: The only valid value is DELETE_WEBSITE_DOMAIN.

Example

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

Create an SSO connection for Canva Websites

An actor triggers this event when they complete the set up of an SSO connection for Canva Websites.

typestring

Default value: CREATE_WEBSITE_SSO_CONNECTION

Available values: The only valid value is CREATE_WEBSITE_SSO_CONNECTION.

domainsAuditLogWebsiteDomain[]

The domains protected by this SSO connection.

idstring

The Web Domain ID.

namestring
Optional

The domain name.

namestring
Optional

The display name of the SSO connection.

idp_issuerstring
Optional

The unique identifier of the SAML application, provided by the Identity Provider (IdP).

idp_login_urlstring
Optional

The login URL where users are redirected for authentication.

idp_certificatestring
Optional

The PEM-encoded X.509 public certificate provided by an Identity Provider (IdP) for SAML authentication.

Example

{
  "id": ...,
  "timestamp": ...,
  "actor": ...,
  "target": ...,
  "action": {
    "type": "CREATE_WEBSITE_SSO_CONNECTION",
    "domains": [
      {
        "id": "dyTYOgOEyqd",
        "name": "example.com"
      }
    ],
    "name": "SSO for example.com",
    "idp_issuer": "https://mysecurityprovider.com/123",
    "idp_login_url": "https://mysecurityprovider.com/sso/saml",
    "idp_certificate": "-----BEGIN CERTIFICATE-----\\nMIIC...\\n-----END CERTIFICATE-----"
  },
  "outcome": ...,
  "context": ...
}
JSON

Update an SSO connection for Canva Websites

An actor triggers this event when they modify an existing SSO connection for Canva Websites, including certificate updates.

We only log the team properties that the actor requested changes for. The changed fields are listed in the changed_fields array.

typestring

Default value: UPDATE_WEBSITE_SSO_CONNECTION

Available values: The only valid value is UPDATE_WEBSITE_SSO_CONNECTION.

changed_fieldsstring[]
Optional

Fields requested to be changed in this update.

Available values:

  • NAME: Update the display name of the SSO connection.
  • DOMAINS: Update the domains protected by this SSO connection.
  • IDP_ISSUER: Update the unique identifier of the SAML application, provided by the Identity Provider (IdP).
  • IDP_LOGIN_URL: Update the login URL where users are redirected for authentication.
  • IDP_CERTIFICATE: Update the X.509 certificate provided by the Identity Provider (IdP) for SAML authentication.
old_namestring
Optional

The previous name of the SSO connection.

new_namestring
Optional

The updated name of the SSO connection.

old_domainsAuditLogWebsiteDomain[]
Optional

The previous domains protected by this SSO connection.

idstring

The Web Domain ID.

namestring
Optional

The domain name.

new_domainsAuditLogWebsiteDomain[]
Optional

The updated domains protected by this SSO connection.

idstring

The Web Domain ID.

namestring
Optional

The domain name.

old_idp_issuerstring
Optional

The previous Identity Provider (IdP) issuer.

new_idp_issuerstring
Optional

The updated Identity Provider (IdP) issuer.

old_idp_login_urlstring
Optional

The previous login URL.

new_idp_login_urlstring
Optional

The updated login URL.

old_idp_certificatestring
Optional

The previous PEM-encoded X.509 public certificate provided by an Identity Provider (IdP) for SAML authentication.

new_idp_certificatestring
Optional

The updated PEM-encoded X.509 public certificate provided by an Identity Provider (IdP) for SAML authentication.

Example

{
  "id": ...,
  "timestamp": ...,
  "actor": ...,
  "target": ...,
  "action": {
    "type": "UPDATE_WEBSITE_SSO_CONNECTION",
    "changed_fields": [
      "NAME",
      "DOMAINS",
      "IDP_ISSUER",
      "IDP_LOGIN_URL",
      "IDP_CERTIFICATE"
    ],
    "old_name": "Old SSO Connection",
    "new_name": "New SSO Connection",
    "old_domains": [
      {
        "id": "dyTYOgOEyqd",
        "name": "example.com"
      }
    ],
    "new_domains": [
      {
        "id": "dyTYOgOEyqd",
        "name": "example.com"
      }
    ],
    "old_idp_issuer": "https://mysecurityprovider.com/123-old",
    "new_idp_issuer": "https://mysecurityprovider.com/456-new",
    "old_idp_login_url": "https://mysecurityprovider.com/sso/old",
    "new_idp_login_url": "https://mysecurityprovider.com/sso/new",
    "old_idp_certificate": "-----BEGIN CERTIFICATE-----\\nMIIC...\\n-----END CERTIFICATE-----",
    "new_idp_certificate": "-----BEGIN CERTIFICATE-----\\nMIID...\\n-----END CERTIFICATE-----"
  },
  "outcome": ...,
  "context": ...
}
JSON

Delete an SSO connection for Canva Websites

An actor triggers this event when they delete an SSO connection for Canva Websites.

typestring

Default value: DELETE_WEBSITE_SSO_CONNECTION

Available values: The only valid value is DELETE_WEBSITE_SSO_CONNECTION.

Example

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