Skip to content
Browse files

Webhook API resource has `body` and `signature` but not `payload`

  • Loading branch information...
1 parent 8750800 commit 5aaba50255b21d4fd560f83e66901faa04d0f963 @moklett moklett committed May 25, 2012
Showing with 10 additions and 5 deletions.
  1. +10 −5 doculab/docs/api-webhooks.textile
View
15 doculab/docs/api-webhooks.textile
@@ -11,7 +11,8 @@ h2. Webhook Attributes
* @id@ The unique identifier
* @successful@ A boolean flag describing whether the webhook was successfully received by the merchant's endpoint
* @event@ A string describing which event type produced the given Webhook
-* @payload@ The data sent within the Webhook request
+* @body@ The data sent within the Webhook post
+* @signature@ The calculated Webhook signature
* @created_at@ Timestamp indicating when the Webhook was created
* @accepted_at@ Timestamp indicating when the Webhook was accepted by the merchant endpoint
* @last_sent_at@ Timestamp indicating when the most recent attempt was made to send the Webhook
@@ -65,7 +66,8 @@ h3(#api-usage-xml-webhook-list). XML List Webhooks for Site Example
<last_error nil="true"></last_error>
<last_error_at type="datetime" nil="true"></last_error_at>
<last_sent_at type="datetime">`auto generated`</last_sent_at>
- <payload type="yaml" nil="true"></payload>
+ <body>`auto generated`</body>
+ <signature>`auto generated`</signature>
<successful type="boolean">true</successful>
</webhook>
<webhook>
@@ -76,7 +78,8 @@ h3(#api-usage-xml-webhook-list). XML List Webhooks for Site Example
<last_error nil="true"></last_error>
<last_error_at type="datetime" nil="true"></last_error_at>
<last_sent_at type="datetime">`auto generated`</last_sent_at>
- <payload type="yaml" nil="true"></payload>
+ <body>`auto generated`</body>
+ <signature>`auto generated`</signature>
<successful type="boolean">true</successful>
</webhook>
</webhooks>
@@ -108,7 +111,8 @@ h3(#api-usage-json-webhook-list). JSON List Webhooks for Site Example
"accepted_at":`auto generated`,
"last_sent_at":`auto generated`,
"created_at":`auto generated`,
- "payload":null,
+ "body":`auto generated`,
+ "signature":`auto generated`,
"successful":true,
"last_error":null,
"id":`auto generated`,
@@ -119,7 +123,8 @@ h3(#api-usage-json-webhook-list). JSON List Webhooks for Site Example
"accepted_at":`auto generated`,
"last_sent_at":`auto generated`,
"created_at":`auto generated`,
- "payload":null,
+ "body":`auto generated`,
+ "signature":`auto generated`,
"successful":true,
"last_error":null,
"id":`auto generated`,

0 comments on commit 5aaba50

Please sign in to comment.
Something went wrong with that request. Please try again.