yetangitu/photo-front
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity

Fixing formatting of the webhook subscribe api doc.

Browse source 
Gh-180
This commit is contained in:
Jaisen Mathai 2011-10-14 17:01:56 -07:00
parent b1dc47e2dd
commit f55f19e19c
1 changed files with 1 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

6
documentation/api/PostWebhookSubscribe.markdown
View file

@ -7,11 +7,6 @@ Open Photo API / Get Photo
1. [Purpose][purpose] 1. [Purpose][purpose]
1. [Endpoint][endpoint] 1. [Endpoint][endpoint]
1. [Parameters][parameters] 1. [Parameters][parameters]
1. [Examples][examples]
* [Command line][example-cli]
* [PHP][example-php]
1. [Response][response]
* [Sample][sample]
---------------------------------------- ----------------------------------------
@ -23,6 +18,7 @@ Use this API to create a new webhook for a user.
This API differs from our others in that it's both interactive and does not return a [Standard Envelope][Envelope]. These are the steps required to complete a webhook subscription. This API differs from our others in that it's both interactive and does not return a [Standard Envelope][Envelope]. These are the steps required to complete a webhook subscription.
<a name="verification"></a> <a name="verification"></a>
1. The consumer _(you)_ makes a POST request to the provider _(the API host)_ to `http://apihost.com/webhook/subscribe` with the <a href="#">required parameters</a>. 1. The consumer _(you)_ makes a POST request to the provider _(the API host)_ to `http://apihost.com/webhook/subscribe` with the <a href="#">required parameters</a>.
1. The provider makes a GET request back to your `callback` URL passing along a `mode`, `topic`, and `challenge` parameter. A `verifyToken` parameter is passed back if originally supplied. 1. The provider makes a GET request back to your `callback` URL passing along a `mode`, `topic`, and `challenge` parameter. A `verifyToken` parameter is passed back if originally supplied.
1. The consumer must validate that the subscription was intended (typically using the `verifyToken`) and print out the `challenge` value with a HTTP 200 response code. 1. The consumer must validate that the subscription was intended (typically using the `verifyToken`) and print out the `challenge` value with a HTTP 200 response code.