Circles Feed

This outlines how to use and interact with the circles feed.

The feed is a collection that relays events that happen related to members.

Set up

Here’s how the relations are set up:

A Feed Event has a Member.
A Circle has many Members.
The Feed Collection has a specific permission - members can view feed events from members that belong in the same circle as them.
Making a general query to the Feed Collection when authenticated as a member will only return feed events from members in their Circles.

Note: Feed Events are not related to circles.
They are related to members, who then grant view permission through circles.

—Considerations—
Because of this relation set up, it is easy to add feed events.

The “Add to Feed” sub-workflow that can post to the feed collection and expects only 4-5 variables at the moment:

member: the member id
content: Feed message
status: the status (see below API section for options)
path: the router path in the app (everything after the url)
- Example: https://tansy.app/appointments/1234 would be /appointments/1234
details: unused as of now - longer description

This examples shows how to add a feed message for a completed appointment. The Edit fields is formatting the 3 parameters:

Make a POST to feed with the following config:

URL
https://pb.tansy.app/api/collections/feed/records

Query Parameters

Body

member: the member id
content: The feed message
status: The status of the feed message. Needs to be one of the following:
reminder, today, open, pending, suggested, booked, completed, canceled, missed
path: the url routing path
details: long description
private: boolean to hide a feed event