sheepFlow

A kanban board for sheepCRM.

Flow Terminology

Term	Description
board	A view with a number of columns, each column having a number of cards. Boards can only represent a single sheepCRM data type.
columns	A board column typically represents a state of a resource, e.g. pending, active.
card	Each record is represented as a card assigned to a column.
base filter	The filter or query which applies to the whole board and cannot be modified by the user.
default filter	A filter layered on top of the base filter but which can be edited or removed by the user. Showing only recently edited records would be a good default filter.

Get Available Boards

GET https://api.sheepcrm.com/api/v1/$FLOCK/flow_board/
Authorization: Bearer $API_KEY

Get a Board with Full Config

GET https://api.sheepcrm.com/api/v1/$FLOCK/flow_board/full/
Authorization: Bearer $API_KEY

Get a Board with Column Config

GET https://api.sheepcrm.com/api/v1/$FLOCK/flow_board/column/
Authorization: Bearer $API_KEY

Get a Board with Full Config and Cards

GET https://api.sheepcrm.com/api/v1/$FLOCK/flow_board/cards/
Authorization: Bearer $API_KEY

Updating Cards (Bulk Actions)

Parameter	Description
column	Column name.
cards	A list of card IDs to update.
action	The bulk action to be applied. See below for options.

Available actions:

• move_cards — Default action if not supplied.
• add_tag / remove_tag — Only applicable to forms. Additional parameter of tag required.
• assign_reviewer / assign_scorer — Only applicable to forms. Additional parameter of user required.
• bulk_xls — Export cards as XLS.

Not all actions are available for all data types and may require premium packages.

POST https://api.sheepcrm.com/api/v1/$FLOCK/flow_board/cards/
Authorization: Bearer $API_KEY
Content-Type: application/json

{
    "column": "active",
    "cards": ["/example/member/5f85c9a880859e454b8124e9/"]
}

HTTP/1.1 200 OK
{
    "data": {
        "errors": [
            "card1 is not a valid card for this board, expected member"
        ],
        "failed": ["card1"],
        "updated": ["/example/member/5f85c9a880859e454b8124e9/"]
    }
}

Configuring a Board

Field	Description
name	Board name.
creator	Creator string.
description	Helpful description of the board’s purpose.
active	Boolean. Use to hide old boards.
resource_type	sheepCRM resource type, e.g. form_response, member.
user_groups	User group permissions for this board. Leave blank for default sheepCRM permissions.
columns	Structured dictionary config.
base_filter	The filter or query which applies to the whole board and cannot be modified by the user.
default_filter	A filter layered on top of the base filter but which can be edited or removed by the user.

PUT https://api.sheepcrm.com/api/v1/$FLOCK/flow_board/{uid}/
Authorization: Bearer $API_KEY
Content-Type: application/json

{
    "base_filter": {"membership_plan_type": "individual"},
    "default_filter": {"amount__gte": 80}
}

HTTP/1.1 200 OK
{
    "errors": {},
    "updates": {
        "base_filter": {"membership_plan_type": "individual"},
        "default_filter": {"amount__gte": 80}
    }
}

This example configures the board to only show individual membership types and by default only show memberships with an amount greater than or equal to 80.

Flow configs are detailed JSON documents and best edited through the user interface. Creating a JSON file (or editing an existing example) and sending through the API is also supported:

PUT https://api.sheepcrm.com/api/v1/$FLOCK/flow_board/{uid}/
Authorization: Bearer $API_KEY
Content-Type: application/json

(contents of flow config JSON file)

Setup Through the User Interface

Create a new Flow Board

1. View existing boards, e.g. https://sheepcrm.com/example/flow_board/

2. Create or Clone:

   • Create a new, empty board: Go to https://sheepcrm.com/example/flow_board/new/
   • Clone an existing board: Go to the board you want to clone and create the clone URL, e.g. https://sheepcrm.com/api/v1/example/flow_board/{uid}/clone/ (note the api/v1/ prefix)

3. Edit the board:

   • Legacy UID — Can be left blank
   • Name — The name for the board
   • Creator — Free text, put your name/email
   • Description — Free text
   • Active — Y
   • Resource Type — Only form responses and memberships are currently supported
   • User Groups — Leave blank
   • Users — Leave blank
   • Columns — Leave blank (not currently used)
   • Base Filter — Leave blank
   • Default Filter — Leave blank

4. Go to https://flow.sheepcrm.com:

   • Look for your new board (caching can mean a 10 minute wait)