Share folder notifications

The NotificationContent sent when a user shares a folder.

If the type of notification is share_folder, 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 shares a folder.

<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 `share_folder`.
      </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_team_user" type="TeamUser" required mode="output">
      Metadata for the user, consisting of the User ID, Team ID, and display name.

      <PillAccordion title={<>Properties of <strong>receiving_team_user</strong></>}>
        <Prop.List>
          <Prop name="user_id" type="string" mode="output">
            The ID of the user.
          </Prop>

          <Prop name="team_id" type="string" mode="output">
            The ID of the user's Canva Team.
          </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="folder" type="FolderSummary" required mode="output">
      This object contains some folder metadata. You can retrieve additional metadata
      using the folder ID and the `/v1/folders/{folderId}` endpoint.

      <PillAccordion title={<>Properties of <strong>folder</strong></>}>
        <Prop.List>
          <Prop name="id" type="string" required mode="output">
            The folder ID.
          </Prop>

          <Prop name="name" type="string" required mode="output">
            The folder name, as shown in the Canva UI.
          </Prop>

          <Prop name="created_at" type="integer" required mode="output">
            When the folder was created, as a Unix timestamp (in seconds since the
            Unix Epoch).
          </Prop>

          <Prop name="updated_at" type="integer" required mode="output">
            When the folder was last updated, as a Unix timestamp (in seconds since the
            Unix Epoch).
          </Prop>

          <Prop name="url" type="string" mode="output">
            The folder URL.
          </Prop>

          <Prop name="title" type="string" deprecated mode="output">
            The folder name, as shown in the Canva UI. This property is deprecated, so you should
            use the `name` property instead.
          </Prop>
        </Prop.List>
      </PillAccordion>
    </Prop>

    <Prop name="share" type="ShareAction" mode="output">
      Metadata about the share event.

      <PillAccordion title={<>Properties of <strong>share</strong></>}>
        <Prop.List>
          <Prop name="message" type="string" required mode="output">
            The optional message users can include when sharing something with another
            user using the Canva UI.
          </Prop>
        </Prop.List>
      </PillAccordion>
    </Prop>
  </Prop.List>
</PillAccordion>

</Prop> </Prop.List>

Example: Share folder notification