ShareNotificationInformation - Huddle/huddle-apis GitHub Wiki

Summary

This resource lists who received a given share (correlation id from the share flow). It is served by the Babble notifications surface.

After a successful 202 Accepted document share or folder share, the Files API returns a Link response header with rel="share-information" whose href uses the path notifications/shares/{correlationId} (see Share). GET that URI (with authentication) to retrieve this payload.

Note: Folder share does not currently expose the same audit / share-information discovery path as document share in all deployments; treat document share as the primary reference for obtaining the correlation id from Link.


Get share information

Item Detail
Method GET
Path /babble/notifications/shares/{shareId}
shareId Guid from the share Link header (same as correlation id). Guid.Empty yields 400 Bad Request.

Example

Request

GET /babble/notifications/shares/565eee8d-7d34-41e1-9c48-19bcc08ccb32 HTTP/1.1
Host: api.huddle.net
Accept: application/json
Authorization: Bearer frootymcnooty/vonbootycherooty

Response

HTTP/1.1 200 OK
Content-Type: application/json
{
  "people": [
    {
      "name": "Mr Pink",
      "email": "[email protected]",
      "rel": "recipient",
      "links": [
        { "rel": "self", "href": "https://api.huddle.net/users/3" },
        { "rel": "alternate", "href": "https://my.huddle.example/user/mrpink", "type": "text/html" },
        { "rel": "avatar", "href": "https://api.huddle.net/files/users/3/avatar?h=…", "type": "image/jpeg" }
      ]
    }
  ]
}

Exact href hosts and query strings depend on environment. Avatars use the Files avatar pattern /files/users/{userId}/avatar, not /users/{id}/avatar.

XML (same resource)

<shareInformation>
  <people name="Mr Pink" email="[email protected]" rel="recipient">
    <link rel="self" href="https://api.huddle.net/users/3" />
    <link rel="alternate" href="https://my.huddle.example/user/mrpink" type="text/html" />
    <link rel="avatar" href="https://api.huddle.net/files/users/3/avatar?h=…" type="image/jpeg" />
  </people>
  <people name="Mr White" email="[email protected]" rel="recipient">
    <link rel="self" href="https://api.huddle.net/users/4" />
    <link rel="alternate" href="https://my.huddle.example/user/mrwhite" type="text/html" />
    <link rel="avatar" href="https://api.huddle.net/files/users/4/avatar?h=…" type="image/jpeg" />
  </people>
</shareInformation>

The order of link elements for each person may vary by service version; rely on rel (self, alternate, avatar).


Errors

Situation Typical response
Invalid / empty shareId 400 Bad Request
Caller not allowed to read share information 403 Forbidden (policy)
Unknown or expired share id 404 Not Found

Schema (informal)

  • Root: shareInformation
  • Zero or more people elements (or JSON people array entries), each with name, email, rel (e.g. recipient) and link children / links array.

Related

  • Notifications — Babble notification list / status APIs.
  • Share — initiating share and share-information Link header.
⚠️ **GitHub.com Fallback** ⚠️