Appearance
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:
<Prop.List> <Prop name="id" type="string" required mode="output"> The unique identifier for the notification. </Prop>
<Prop name="created_at" type="integer" required mode="output"> When the notification was created, as a UNIX timestamp (in seconds since the UNIX epoch). </Prop>
<Prop name="content" type="object" required mode="output"> The notification content for when someone is invited to a Canva team.
<PillAccordion title={<>Properties of <strong>content</strong></>} defaultExpanded={true}>
<Prop.List>
<Prop name="type" type="string" required mode="output">
<Prop.Extras>
**Available values:** The only valid value is `team_invite`.
</Prop.Extras>
</Prop>
<Prop name="triggering_user" type="User" required mode="output">
Metadata for the user, consisting of the User ID and display name.
<PillAccordion title={<>Properties of <strong>triggering_user</strong></>}>
<Prop.List>
<Prop name="id" type="string" required mode="output">
The ID of the user.
</Prop>
<Prop name="display_name" type="string" mode="output">
The name of the user as shown in the Canva UI.
</Prop>
</Prop.List>
</PillAccordion>
</Prop>
<Prop name="receiving_user" type="User" required mode="output">
Metadata for the user, consisting of the User ID and display name.
<PillAccordion title={<>Properties of <strong>receiving_user</strong></>}>
<Prop.List>
<Prop name="id" type="string" required mode="output">
The ID of the user.
</Prop>
<Prop name="display_name" type="string" mode="output">
The name of the user as shown in the Canva UI.
</Prop>
</Prop.List>
</PillAccordion>
</Prop>
<Prop name="inviting_team" type="Team" required mode="output">
Metadata for the Canva Team, consisting of the Team ID,
display name, and whether it's an external Canva Team.
<PillAccordion title={<>Properties of <strong>inviting_team</strong></>}>
<Prop.List>
<Prop name="id" type="string" required mode="output">
The ID of the Canva Team.
</Prop>
<Prop name="display_name" type="string" required mode="output">
The name of the Canva Team as shown in the Canva UI.
</Prop>
<Prop name="external" type="boolean" required mode="output">
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.
</Prop>
</Prop.List>
</PillAccordion>
</Prop>
</Prop.List>
</PillAccordion>
</Prop> </Prop.List>