Skip to content

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.

&lt;PillAccordion title={&lt;&gt;Properties of &lt;strong&gt;content&lt;/strong&gt;&lt;/&gt;} defaultExpanded={true}&gt;
  &lt;Prop.List&gt;
    &lt;Prop name="type" type="string" required mode="output"&gt;
      &lt;Prop.Extras&gt;
        **Available values:** The only valid value is `team_invite`.
      &lt;/Prop.Extras&gt;
    &lt;/Prop&gt;

    &lt;Prop name="triggering_user" type="User" required mode="output"&gt;
      Metadata for the user, consisting of the User ID and display name.

      &lt;PillAccordion title={&lt;&gt;Properties of &lt;strong&gt;triggering_user&lt;/strong&gt;&lt;/&gt;}&gt;
        &lt;Prop.List&gt;
          &lt;Prop name="id" type="string" required mode="output"&gt;
            The ID of the user.
          &lt;/Prop&gt;

          &lt;Prop name="display_name" type="string" mode="output"&gt;
            The name of the user as shown in the Canva UI.
          &lt;/Prop&gt;
        &lt;/Prop.List&gt;
      &lt;/PillAccordion&gt;
    &lt;/Prop&gt;

    &lt;Prop name="receiving_user" type="User" required mode="output"&gt;
      Metadata for the user, consisting of the User ID and display name.

      &lt;PillAccordion title={&lt;&gt;Properties of &lt;strong&gt;receiving_user&lt;/strong&gt;&lt;/&gt;}&gt;
        &lt;Prop.List&gt;
          &lt;Prop name="id" type="string" required mode="output"&gt;
            The ID of the user.
          &lt;/Prop&gt;

          &lt;Prop name="display_name" type="string" mode="output"&gt;
            The name of the user as shown in the Canva UI.
          &lt;/Prop&gt;
        &lt;/Prop.List&gt;
      &lt;/PillAccordion&gt;
    &lt;/Prop&gt;

    &lt;Prop name="inviting_team" type="Team" required mode="output"&gt;
      Metadata for the Canva Team, consisting of the Team ID,
      display name, and whether it's an external Canva Team.

      &lt;PillAccordion title={&lt;&gt;Properties of &lt;strong&gt;inviting_team&lt;/strong&gt;&lt;/&gt;}&gt;
        &lt;Prop.List&gt;
          &lt;Prop name="id" type="string" required mode="output"&gt;
            The ID of the Canva Team.
          &lt;/Prop&gt;

          &lt;Prop name="display_name" type="string" required mode="output"&gt;
            The name of the Canva Team as shown in the Canva UI.
          &lt;/Prop&gt;

          &lt;Prop name="external" type="boolean" required mode="output"&gt;
            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.
          &lt;/Prop&gt;
        &lt;/Prop.List&gt;
      &lt;/PillAccordion&gt;
    &lt;/Prop&gt;
  &lt;/Prop.List&gt;
&lt;/PillAccordion&gt;

</Prop> </Prop.List>

Example: Design access requested notification

Canva Developer Documentation SOP Site