Design approval response notifications

The NotificationContent sent when a user responds to a design approval request.

If the type of notification is design_approval_response, 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 approves a design or gives feedback.

<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 `design_approval_response`.
      </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="initial_requesting_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>initial_requesting_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="responding_groups" type="Group[]" required mode="output">
      Metadata for the Canva Group, consisting of the Group ID,
      display name, and whether it's an external Canva Group.

      <PillAccordion title={<>Properties of <strong>responding_groups</strong></>}>
        <Prop.List>
          <Prop name="id" type="string" required mode="output">
            The ID of the group with permissions to access the design.
          </Prop>

          <Prop name="external" type="boolean" required mode="output">
            Is the user making the API call (the authenticated user) and the Canva Group
            from different Canva Teams?

            * When `true`, the user and the group aren't in the same Canva Team.
            * When `false`, the user and the group are in the same Canva Team.
          </Prop>

          <Prop name="display_name" type="string" mode="output">
            The display name of the group.
          </Prop>
        </Prop.List>
      </PillAccordion>
    </Prop>

    <Prop name="design" type="DesignSummary" required mode="output">
      Basic details about the design, such as the design's ID, title, and URL.

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

          <Prop name="urls" type="DesignLinks" required mode="output">
            A temporary set of URLs for viewing or editing the design.

            <PillAccordion title={<>Properties of <strong>urls</strong></>}>
              <Prop.List>
                <Prop name="edit_url" type="string" required mode="output">
                  A temporary editing URL for the design. This URL is only accessible to the user that made the API request, and is designed to support return navigation workflows.

                  NOTE: This is not a permanent URL, it is only valid for 30 days.
                </Prop>

                <Prop name="view_url" type="string" required mode="output">
                  A temporary viewing URL for the design. This URL is only accessible to the user that made the API request, and is designed to support return navigation workflows.

                  NOTE: This is not a permanent URL, it is only valid for 30 days.
                </Prop>
              </Prop.List>
            </PillAccordion>
          </Prop>

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

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

          <Prop name="title" type="string" mode="output">
            The design title.
          </Prop>

          <Prop name="url" type="string" mode="output">
            URL of the design.
          </Prop>

          <Prop name="thumbnail" type="Thumbnail" mode="output">
            A thumbnail image representing the object.

            <PillAccordion title={<>Properties of <strong>thumbnail</strong></>}>
              <Prop.List>
                <Prop name="width" type="integer" required mode="output">
                  The width of the thumbnail image in pixels.
                </Prop>

                <Prop name="height" type="integer" required mode="output">
                  The height of the thumbnail image in pixels.
                </Prop>

                <Prop name="url" type="string" required mode="output">
                  A URL for retrieving the thumbnail image.
                  This URL expires after 15 minutes. This URL includes a query string
                  that's required for retrieving the thumbnail.
                </Prop>
              </Prop.List>
            </PillAccordion>
          </Prop>

          <Prop name="page_count" type="integer" mode="output">
            The total number of pages in the design. Some design types don't have pages (for example, Canva docs).
          </Prop>
        </Prop.List>
      </PillAccordion>
    </Prop>

    <Prop name="approval_response" type="ApprovalResponseAction" required mode="output">
      Metadata about the design approval response.

      <PillAccordion title={<>Properties of <strong>approval_response</strong></>}>
        <Prop.List>
          <Prop name="approved" type="boolean" required mode="output">
            Whether the design was approved. When `true`, the reviewer has approved
            the design.
          </Prop>

          <Prop name="ready_to_publish" type="boolean" mode="output">
            Whether the design is ready to publish. When `true`, the design has been approved
            by all reviewers and can be published.
          </Prop>

          <Prop name="message" type="string" mode="output">
            The message included by a user responding to a design approval request.
          </Prop>
        </Prop.List>
      </PillAccordion>
    </Prop>
  </Prop.List>
</PillAccordion>

</Prop> </Prop.List>

Example: Design approval response notification