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:
- Publish Canva websites(opens in a new tab or window).
- Change website slug, favicon, and other settings(opens in a new tab or window).
type
string
Default value: CREATE_DOMAIN
Available values: The only valid value is CREATE_DOMAIN
.
domain_type
string
The type of domain being created.
Available values:
FREE
: A free my.canva.site domain name(opens in a new tab or window) selected by the user or allocated by Canva.USER_ADDED
: An existing domain name(opens in a new tab or window) owned by the user.PURCHASED
: A domain name purchased by the user(opens in a new tab or window) from Canva.
name
string
The domain name (subdomain and the top-level domain).
Example
{"id": ...,"timestamp": ...,"actor": ...,"target": ...,"action": {"type": "CREATE_DOMAIN","domain_type": "FREE","name": "example.com"},"outcome": ...,"context": ...}
Update a website domain's details
An actor
triggers this event when they modify the data associated with an existing domain.
type
string
Default value: UPDATE_DOMAIN
Available values: The only valid value is UPDATE_DOMAIN
.
update_type
string
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_name
string
OptionalThe old domain name (shown when the update_type
is RENAME
)
new_domain_name
string
OptionalThe new domain name (shown when the update_type
is RENAME
)
old_dns_records
DnsRecord[]
OptionalThe old DNS records (shown when the update_type
is either UPDATE_RECORDS
or RESET_NAMESERVER_RECORDS
).
name
string
The record name.
type
string
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.
value
string
The record value.
new_dns_records
DnsRecord[]
OptionalThe new custom DNS records (shown when the update_type
is either UPDATE_RECORDS
or RESET_NAMESERVER_RECORDS
).
name
string
The record name.
type
string
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.
value
string
The record value.
new_contact_info
ContactInfo
OptionalThe contact information for a domain owner.
name
string
The combined first and last name of the owner.
email
string
The owner's email address.
phone
string
The owner's phone number
address
string
The street and number of the owner's address.
city
string
The city in the owner's address.
country
string
The two-letter ISO country code representing the country in the owner's address.
organization_name
string
OptionalThe name of the organisation that owns the domain.
postcode
string
OptionalThe postal code in the owner's address.
state
string
OptionalThe state of the owner's address.
language
string
OptionalLanguage used for messaging the owner.
Example
{"id": ...,"timestamp": ...,"actor": ...,"target": ...,"action": {"type": "UPDATE_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": "","value": "192.168.0.12"},{"name": "example.com","type": "CNAME","value": "subdomain.example.com"}],"new_contact_info": {"name": "John Doe","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": ...}
Delete a website domain
An actor
triggers this event when they delete a domain.
type
string
Default value: DELETE_DOMAIN
Available values: The only valid value is DELETE_DOMAIN
.
Example
{"id": ...,"timestamp": ...,"actor": ...,"target": ...,"action": {"type": "DELETE_DOMAIN"},"outcome": ...,"context": ...}