kind:change

title:New Payload format for Deployments

created_at:2014-03-03

author_name:atmos

As we[iterate on the preview][january-deployment-api-post] for the new Deployment API, we're making sure that it's friendly to work with for the apps built on top of it.

To make the API even easier to use, we'll now return your custom payload as a JSON object along with the rest of the Deployment resource. No need to parse it as JSON again.

You should only need to remove the JSON parsing if you're taking advantage of the custom payloads. The formats for creating Deployments remain unchanged.

As always, if you have any questions or feedback, please[get in touch][contact].

[january-deployment-api-post]:/changes/2014-01-09-preview-the-new-deployments-api/

[contact]:https://github.com/contact?form[subject]=Deployments+API

<<<<<<< HEAD

There are a few things that can go wrong in the process of obtaining an

OAuth token for a user. In the initial authorization request phase,

these are some errors you might see:

If the OAuth application you set up has been suspended (due to reported

abuse, spam, or a mis-use of the API), GitHub will redirect to the

registered callback URL with the following parameters summerizing the

error:

Please contact[support](https://github.com/contact) to solve issues

with suspended applications.

If you provide a redirect_uri that doesn't match what you've registered

with your application, GitHub will redirect to the registered callback

URL with the following parameters summerizing the error:

To correct this error, either provide a redirect_uri that matches what

you registered or leave out this parameter to use the default one

registered with your application.

If the user rejects access to your application, GItHub will redirect to

the registered callback URL with the following parameters summerizing

the error:

There's nothing you can do here as users are free to choose not to use

your application. More often that not, users will just close the window

or press back in their browser, so it is likely that you'll never see

this error.

In the second phase of exchanging a code for an access token, there are

an additional set of errors that can occur. The format of these

responses is determined by the accept header you pass. The following

examples only show JSON responses.

If the client\_id and or client\_secret you pass are incorrect you will

receive this error response.

<%= json:error =>:invalid_client_credentials %>

To solve this error, go back and make sure you have the correct

credentials for your oauth application. Double check the`client_id` and

`client_secret` to make sure they are correct and being passed correctly

to GitHub.

If the verification code you pass is incorrect, expired, or doesn't

match what you received in the first request for authorization you will

receive this error.

<%= json:error =>:bad_verification_code %>

There are a few things that can go wrong in the process of obtaining an

OAuth token for a user. In the initial authorization request phase,

:error_uri => "http://developer.github.com/v3/oauth/#bad-verification-code"

%>

To solve this error, start the[OAuth process over from the beginning](#redirect-users-to-request-github-access)

and get a new code.

`team_id`|`number` | The id of the team that will be granted access to this repository. This is only valid when creating a repository in an organization.

`auto_init`|`boolean` | Pass`true` to create an initial commit with empty README. Default:`false`

`gitignore_template`|`string` | Desired language or platform[.gitignore template](https://github.com/github/gitignore) to apply. Use the name of the template without the extension. For example, "Haskell"._Ignored if the`auto_init` parameter is not provided._

`license_template`|`string` | Desired[LICENSE template](https://github.com/github/choosealicense.com) to apply. Use the[name of the template](https://github.com/github/choosealicense.com/tree/gh-pages/licenses) without the extension. For example, "mit" or "mozilla"._Ignored if the`auto_init` parameter is not provided._

To set up a webhook on GitHub, head over to the**Settings** page of your repository,

and click on**Webhooks & services**. After that, click on**Add webhook**.

You'll be presented with a page that lists all the capabilities your webhook

can take advantage of. We'll go through each of these below.

Alternatively, you can choose to build and manage a webhook[through the Webhooks API][webhook-api].

Webhooks require a few configuration options before you can use of them.

We'll go through each of these settings below.

it's time to set up our local server to test the webhook. Head on over to

[Configuring Your Server](/webhooks/configuring/) to learn how to do that.

[hooks-api]:http://developer.github.com/v3/repos/hooks/#events

[webhook-api]:/v3/repos/hooks/

[hooks-api]:/webhooks/#events