Differences

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

--- developer_guide:developer_guide:webhooks [2012/02/26 02:08] – created matt
+++ developer_guide:developer_guide:webhooks [2013/05/07 10:33] (current) – [WebHook POST Fields] matt
@@ Line 7: / Line 7: @@
 "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 app 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 post-backs to grant customers access to special content, and restrict access to others.
+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]].
@@ Line 31: / Line 31: @@
 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 any other form on your web site.
+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 =====
-==== Onetime Payments Fields ====
+^ Name ^ Example ^
+| Amount | 44.98 |
+| BillAddress | 55 Main St. |
+| BillAddress2 | Suite 500 |
+| BillCity | Cityville |
+| BillCompany | Widget, Inc. |
+| BillCountry | US |
+| BillFirstName | Jane |
+| BillLastName | Doe |
+| BillPhone | 555-555-5555 |
+| BillState | CA |
+| BillZip | 55555 |
+| CustomerID | 0123456789 |
+| DtCreated | 3/7/2013 6:04 AM |
+| Email | no-reply@subscriptionbridge.com |
+| EndDate | 1/1/1900 12:00 AM |
+| EndDateTrial | 4/7/2013 6:04 AM |
+| EventCode | sb_n_4a |
+| FirstName | Jane |
+| Guid | ABC123456789 |
+| LastName | Doe |
+| NextBillingAmount | 39 |
+| NextBillingDate | 6/7/2013 6:04 AM |
+| PackageName | Widget 123 - Monthly |
+| PlanName | Monthly |
+| ProductName | Widget 123 |
+| ShipAddress | 55 Main St. |
+| ShipAddress2 | Suite 500 |
+| ShipCity | Cityville |
+| ShipCompany | Widget, Inc. |
+| ShipCountry | US |
+| ShipFirstName | Jane |
+| ShipLastName | Doe |
+| ShipPhone | 555-555-5555 |
+| ShipState | CA |
+| ShipZip | 55555 |
+| SID | my custom field |
+| StartDate | 3/7/2013 6:04 AM |
+| Status | Active |
+| StoreActive | True |
+| StoreAddress | 123 South St. |
+| StoreEmail | no-reply@subscriptionbridge.com |
+| StoreID | 1234 |
+| StoreKey | subdomain |
+| StoreLocale | en-US |
+| StoreTimeZone | -5 |
+| TaxAmount | 0 |
+| TransactionAmount | 39.00 |
+| TransactionCurrency | USD |
+| TransactionDtCreated | 5/7/2013 7:30:03 AM |
+| TransactionID | ABC1234 |
+| TransactionMessageCode | 100 |
+| TransactionMessageText | SUCCESS |
+| TransactionRefID | ABC0123456789 |
+| TransactionResultCode | 100 |
+| TransactionType | recurring_payment |