Introduction

Sprint.ly offers a number of outbound integrations with other services. One of which are webhooks, which are user defined callbacks over HTTP. In other words, Sprint.ly will send a JSON payload via POST to URLs that you specify in your product settings.

Payload

Sprint.ly sends a JSON body as the raw POST body. In other words, it does not send a Content-Type of application/x-www-form-urlencoded with a JSON payload as one of the keys, rather it sends a Content-Type of application/json where the POST data is the JSON payload.

All of the payloads include three attributes:

• product A dictionary with information about the product in which the payload comes from.
• model What type of payload the data contains. Will be one of Item, Favorite, Block, or Comment.
  
• attributes The individual data attributes of the given model.

Models

Sprint.ly currently sends an outbound call to your callback whenever a new item is created, someone indicates they are blocked on an item, when someone favorites an item, and when a new comment is added to an item.

NOTE: Sprint.ly only makes a call to your callback URL when a new object is created. We will not send calls on updates or deletes.

Item

Favorite

Block

Comment