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.
NOTE: Currently, GitHub webhooks are unsupported.
This article shows you how to set up your webhook.
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:
-
productA dictionary with information about the product in which the payload comes from. -
modelWhat type of payload the data contains. Will be one ofItem,Favorite,Block, orComment. -
attributesThe individual data attributes of the givenmodel.
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
{
"attributes": {
"archived": false,
"assigned_to": {
"created_at": "2011-06-07T21:10:52+00:00",
"email": "joe@example.com",
"first_name": "Joe",
"id": 1111,
"last_login": "2012-07-26T23:16:55+00:00",
"last_name": "Stump"
},
"created_at": "2012-08-13T23:14:26+00:00",
"created_by": {
"created_at": "2011-06-07T21:10:52+00:00",
"email": "joe@example.com",
"first_name": "Joe",
"id": 1111,
"last_login": "2012-07-26T23:16:55+00:00",
"last_name": "Stump"
},
"description": "",
"email": {
"discussion": "discussion-1111@example.com",
"files": "files-1111@example.com"
},
"last_modified": "2012-08-13T23:14:27+00:00",
"number": 1212,
"product": {
"archived": false,
"id": 1111,
"name": "sprint.ly"
},
"score": "~",
"short_url": "http://sprint.ly/i/1/116550/",
"status": "backlog",
"title": "As a user, I want outbound service hooks so that I will see new items announced in Campfire or HipChat.",
"type": "story",
"what": "outbound service hooks",
"who": "user",
"why": "I will see new items announced in Campfire or HipChat"
},
"model": "Item",
"product": {
"admin": false,
"archived": false,
"created_at": "2011-06-07T21:44:36+00:00",
"email": {
"backlog": "backlog-1111@example.com",
"defects": "defects-1111@example.com",
"stories": "stories-1111@example.com",
"tasks": "tasks-1111@example.com",
"tests": "tests-1111@example.com"
},
"id": 1111,
"name": "sprint.ly"
}
} Favorite
{
"attributes": {
"created_at": "2012-08-12T23:01:33+00:00",
"id": 1111,
"item": {
"archived": false,
"assigned_to": {
"created_at": "2011-06-08T17:16:58+00:00",
"email": "graham@example.com",
"first_name": "Graham",
"id": 1111,
"last_login": "2012-07-18T00:06:37+00:00",
"last_name": "Blache"
},
"created_at": "2012-05-09T01:16:25+00:00",
"created_by": {
"created_at": "2011-06-07T21:10:52+00:00",
"email": "joe@example.com",
"first_name": "Joe",
"id": 1111,
"last_login": "2012-07-26T23:16:55+00:00",
"last_name": "Stump"
},
"description": "",
"email": {
"discussion": "discussion-1111@example.com",
"files": "files-1111@example.com"
},
"last_modified": "2012-08-12T23:01:33+00:00",
"number": 1111,
"product": {
"archived": false,
"id": 1111,
"name": "sprint.ly"
},
"progress": {
"started_at": "2012-07-12T16:40:11+00:00"
},
"score": "XL",
"short_url": "http://sprint.ly/i/1111/1111/",
"status": "in-progress",
"tags": [
"post-launch"
],
"title": "As a user, I want a global filter UI so that I can use filters on the dashboard and timelines.",
"type": "story",
"what": "a global filter UI",
"who": "user",
"why": "I can use filters on the dashboard and timelines"
},
"user": {
"created_at": "2011-06-07T21:10:52+00:00",
"email": "joe@example.com",
"first_name": "Joe",
"id": 1111,
"last_login": "2012-07-26T23:16:55+00:00",
"last_name": "Stump"
}
},
"model": "Favorite",
"product": {
"admin": false,
"archived": false,
"created_at": "2011-06-07T21:44:36+00:00",
"email": {
"backlog": "backlog-1111@example.com",
"defects": "defects-1111@example.com",
"stories": "stories-1111@example.com",
"tasks": "tasks-1111@example.com",
"tests": "tests-1111@example.com"
},
"id": 1111,
"name": "sprint.ly"
}
} Block
{
"attributes": {
"blocked": {
"archived": false,
"assigned_to": {
"created_at": "2011-06-07T21:10:52+00:00",
"email": "joe@example.com",
"first_name": "Joe",
"id": 1111,
"last_login": "2012-07-26T23:16:55+00:00",
"last_name": "Stump"
},
"created_at": "2012-03-30T00:57:20+00:00",
"created_by": {
"created_at": "2011-06-07T21:10:52+00:00",
"email": "joe@example.com",
"first_name": "Joe",
"id": 1,
"last_login": "2012-07-26T23:16:55+00:00",
"last_name": "Stump"
},
"description": "Send out an email if the person's CC expires soon.",
"email": {
"discussion": "discussion-1111@example.com",
"files": "files-1111@example.com"
},
"last_modified": "2012-08-12T22:53:48+00:00",
"number": 2222,
"product": {
"archived": false,
"id": 1111,
"name": "sprint.ly"
},
"score": "M",
"short_url": "http://sprint.ly/i/1111/1111/",
"status": "backlog",
"tags": [
"billing"
],
"title": "As a customer, I want to be notified before my CC expires so that I can update my billing details.",
"type": "story",
"what": "to be notified before my CC expires",
"who": "customer",
"why": "I can update my billing details"
},
"created_at": "2012-08-12T22:53:47+00:00",
"id": 1111,
"item": {
"archived": false,
"assigned_to": {
"created_at": "2012-01-06T23:07:20+00:00",
"email": "craig@example.com",
"first_name": "Craig",
"id": 1111,
"last_login": "2012-06-25T11:09:26+00:00",
"last_name": "Pattison"
},
"created_at": "2012-06-23T21:24:40+00:00",
"created_by": {
"created_at": "2011-06-07T21:10:52+00:00",
"email": "joe@example.com",
"first_name": "Joe",
"id": 1111,
"last_login": "2012-07-26T23:16:55+00:00",
"last_name": "Stump"
},
"description": "Right now when the application is booting up we have a white spinner. Let's change the spinner to our running man that glows from black to blue and back again.",
"email": {
"discussion": "discussion-1111@example.com",
"files": "files-1111@example.com"
},
"last_modified": "2012-08-12T22:53:48+00:00",
"number": 2222,
"product": {
"archived": false,
"id": 1111,
"name": "sprint.ly"
},
"progress": {
"started_at": "2012-06-25T08:55:36+00:00"
},
"score": "M",
"short_url": "http://sprint.ly/i/1111/1111/",
"status": "in-progress",
"tags": [
"ios",
"ipad"
],
"title": "Change the spinner to our glowing running man.",
"type": "task"
},
"unblocked": false,
"user": {
"created_at": "2011-06-07T21:10:52+00:00",
"email": "joe@example.com",
"first_name": "Joe",
"id": 1111,
"last_login": "2012-07-26T23:16:55+00:00",
"last_name": "Stump"
}
},
"model": "Block",
"product": {
"admin": false,
"archived": false,
"created_at": "2011-06-07T21:44:36+00:00",
"email": {
"backlog": "backlog-1111@example.com",
"defects": "defects-1111@example.com",
"stories": "stories-1111@example.com",
"tasks": "tasks-1111@example.com",
"tests": "tests-1111@example.com"
},
"id": 1111,
"name": "sprint.ly"
}
}Comment
{
"attributes": {
"body": "Hey guys, what's the status on this?",
"created_at": "2012-08-13T23:21:52+00:00",
"created_by": {
"created_at": "2011-06-07T21:10:52+00:00",
"email": "joe@example.com",
"first_name": "Joe",
"id": 1111,
"last_login": "2012-07-26T23:16:55+00:00",
"last_name": "Stump"
},
"id": 1111,
"item": {
"archived": false,
"assigned_to": {
"created_at": "2012-01-06T23:07:20+00:00",
"email": "craig@example.com",
"first_name": "Craig",
"id": 1111,
"last_login": "2012-06-25T11:09:26+00:00",
"last_name": "Pattison"
},
"created_at": "2012-06-23T21:24:40+00:00",
"created_by": {
"created_at": "2011-06-07T21:10:52+00:00",
"email": "joe@example.com",
"first_name": "Joe",
"id": 1111,
"last_login": "2012-07-26T23:16:55+00:00",
"last_name": "Stump"
},
"description": "Right now when the application is booting up we have a white spinner. Let's change the spinner to our running man that glows from black to blue and back again.",
"email": {
"discussion": "discussion-1111@example.com",
"files": "files-1111@example.com"
},
"last_modified": "2012-08-12T22:58:34+00:00",
"number": 1212,
"product": {
"archived": false,
"id": 1111,
"name": "sprint.ly"
},
"progress": {
"started_at": "2012-06-25T08:55:36+00:00"
},
"score": "M",
"short_url": "http://sprint.ly/i/1/91594/",
"status": "in-progress",
"tags": [
"ios",
"ipad"
],
"title": "Change the spinner to our glowing running man.",
"type": "task"
},
"last_modified": "2012-08-13T23:21:52+00:00",
"type": "comment"
},
"model": "Comment",
"product": {
"admin": false,
"archived": false,
"created_at": "2011-06-07T21:44:36+00:00",
"email": {
"backlog": "backlog-1111@example.com",
"defects": "defects-1111@example.com",
"stories": "stories-1111@example.com",
"tasks": "tasks-1111@example.com",
"tests": "tests-1111@example.com"
},
"id": 1111,
"name": "sprint.ly"
}
}