Webhook Implementation (v1):

In the settings section of your Pushpin Planner account, you can define urls that our API will POST to when certain actions occur.

  1. card.added - Card Added
  1. POST card object
  1. card.modified - Card Modified (including Assigned Resource Updates)
  1. POST card object
  1. card.deleted - Card Deleted
  1. POST card id

API Documentation (v2.0):

  1. /api/v1/authenticate/<API key>
  1. Go to -> Developer API in your Pushpin Planner Account Settings to locate or generate a unique API key
  1. GET /api/v1/boards/ids
  1. Returns back XML or JSON of all board names / ids belonging to that user
  1. GET /api/v1/boards/<board id>
  1. Returns back XML or JSON of the entire board with the following heirarchy
  1. Board
  1. Lists
  1. Card
  1. Card id
  2. Needed
  3. Ranges
  1. Range Assignment
  1. Assigned Value
  2. Range assignment id
  3. Resource ID
  1. Range Assignment
  1. Assigned Value
  2. Range assignment id
  3. Resource ID
  1. Card
  1. Card id
  2. Needed
  3. Ranges
  1. Range Assignment
  1. Assigned Value
  2. Range assignment id
  3. Resource ID
  1. Range Assignment
  1. Assigned Value
  2. Range assignment id
  3. Resource ID

  1. Resources
  1. Resource
  1. Resource ID
  2. Name
  3. Ranges
  1. rid
  1. Available
  2. Assigned

  1. Resource
  1. Resource ID
  2. Name
  3. Ranges
  1. rid
  1. Available
  2. Assigned
  1. GET /api/v1/boards/<board id>/cards
  1. Checks that board belongs to user
  2. Returns back JSON of all cards *with* range assignments of all cards on that board
  1. CREATE, POST /api/v1/lists/<list id>/cards
  1. Card object example (bold values are required):
  1. {
  2.         "name": "Pushpin Planner API",
  3.         "field_values": [
  4.             "Created automatically"
  5.         ],
  6.         "point_values": {},
  7.         "related_fields": {},
  8.         "weight": 3,
  9.         "bar_chart_view": true,
  10. }
  1. The board_id and list_id are figured out from the <list id> passed in the URL.
  2. field_values[0] is the card description
  3. Assigned resources can't be added with the card callbacks; the ranges and resources properties returned by the API are simulated and not part of the card itself.

  1. PATCH, POST /api/v1/cards/<card id>
  1. Checks to ensure card is not archived (active) and that the user has permission to update it.
  2. Accepts a card object, loops through each element and updates any fields that are set.
  3. Currently only updates top-level fields, so send the whole content of the field that should be saved in the card.

  1. DELETE /api/v1/cards/<card id>
  1. Don’t forget to delete assigned resource values

  1. GET /api/v1/boards/<board id>/resources
  2. CREATE, POST /api/v1/boards/<board id>/resources

  1. PATCH, POST /api/v1/resources/<resource id>
  2. DELETE /api/v1/resources/<resource id>
  1. Don’t forget to remove assigned resource values!