Team invite notifications

The NotificationContent sent when inviting a user to join a team.

If the type of notification is team_invite, the webhook payload object contains the following parameters:

#idstring

The unique identifier for the notification.

#created_atinteger

When the notification was created, as a UNIX timestamp (in seconds since the UNIX epoch).

#contentobject

The notification content for when someone is invited to a Canva team.

Properties of content
#typestring

The value for this can only be team_invite.

#triggering_userUser

Metadata for the user, consisting of the User ID and display name.

Properties of triggering_user
#idstring

The ID of the user.

#display_namestring
Optional

The name of the user as shown in the Canva UI.

#receiving_userUser

Metadata for the user, consisting of the User ID and display name.

Properties of receiving_user
#idstring

The ID of the user.

#display_namestring
Optional

The name of the user as shown in the Canva UI.

#inviting_teamTeam

Metadata for the Canva Team, consisting of the Team ID, display name, and whether it's an external Canva Team.

Properties of inviting_team
#idstring

The ID of the Canva Team.

#display_namestring

The name of the Canva Team as shown in the Canva UI.

#externalboolean

Is the user making the API call (the authenticated user) from the Canva Team shown?

  • When true, the user isn't in the Canva Team shown.
  • When false, the user is in the Canva Team shown.
{
"id": "eb595730",
"created_at": 1377396000,
"content": {
"type": "team_invite",
"triggering_user": {
"id": "uKakKUfI03Fg8k2gZ6OkT",
"display_name": "John Doe"
},
"receiving_user": {
"id": "uKakKUfI03Fg8k2gZ6OkT",
"display_name": "John Doe"
},
"inviting_team": {
"id": "Oi2RJILTrKk0KRhRUZozX",
"display_name": "Acme Corporation",
"external": true
}
}
}
json