developer_guide:developer_guide:webhooks
no way to compare when less than two revisions

Differences

This shows you the differences between two versions of the page.


Previous revision
Last revision
developer_guide:developer_guide:webhooks [2013/05/07 10:11] – [Onetime Payments Fields] matt
Line 1: Line 1:
 +====== WebHooks ======
  
 +===== What is a Webhook? =====
 +
 +Taken directly from the official WebHook website: 
 +
 +"The concept of a WebHook is simple. A WebHook is an HTTP callback: an HTTP POST that occurs when something happens; a simple event-notification via HTTP POST."
 +
 +In other words, a WebHook is a method by which your application can react to events that occur during the Subscription Life cycle (e.g. a new subscription, a recurring payment is declined, a subscription is upgraded, etc.).  For example, your blog or iPhone app can use WebHooks to grant customers access to special content, and restrict access to others.
 +
 +For more information, you can read more at the [[http://wiki.webhooks.org/w/page/13385124/FrontPage|official webhook site]].
 +
 +===== How it works =====
 +A WebHook URL is saved in your Merchant Settings.  The URL points to a script in your app.  We send a form POST message to your script when there is an event (e.g. a sign-up). Your script uses the information in the POST to trigger an action (e.g. enable content to a new user). 
 +
 +A [[merchant_guide:notifications_list_callbackurl|full list of events]] and sample scripts are available.
 +
 +===== WebHook URL =====
 +
 +The WebHook URL, which is set in the [[merchant_guide:notifications|Notification Settings]] area of the Merchant Center (separately for each //store//), defines the location of script on your Web site or App that contains code designed by you to interpret and react to the information provided by SubscriptionBridge in the //post-back message//.
 +
 +Here the steps required to configure your Webhook URL:
 +  - Log into the [[https://www.subscriptionbridge.com/merchantcenter/login.asp|Merchant Center]].
 +  - Navigate to "Notification Settings"
 +  - Under "Advanced Settings" find "Post-back / Webhook URL"
 +  - Type your URL into the box. We recommend using a secure URL.
 +  - Click "Save Notification Settings" at the bottom of the page.
 +
 +===== Webhook Script =====
 +
 +Unlike Post-backs, a Webhook POST can be received without any complex parsing.
 +
 +Since the Webhook is a form POST you can retrieve the values the same way you would with any other form on your web site.
 +
 +===== WebHook POST Fields =====
 +
 +^ Name ^ Example ^ 
 +| Amount | 44.98 | 
 +===== Testing WebHooks =====
 +
 +We recommend that you use a site, such as [[http://postcatcher.in/|PostCatcher]], to collect the WebHooks.
developer_guide/developer_guide/webhooks.txt · Last modified: 2013/05/07 10:33 by matt