Merge remote-tracking branch 'origin/webhooks_api' into webhooks_api

Author: Tejas-Sangani

CHANGELOG.md

@@ -1,8 +1,8 @@
 [OST JAVA SDK v2.2.0](https://github.com/ostdotcom/ost-sdk-java/tree/v2.2.0)
 ---
 
-* Added webhooks module to call webhook management OST APIs
-* Support for verify webhook signature
+* Added webhooks module to call webhook management OST APIs.
+* Support for verify webhook signature.
 
 [OST JAVA SDK v2.1.0](https://github.com/ostdotcom/ost-sdk-java/tree/v2.1.0)
 ---

README.md

@@ -571,15 +571,6 @@ webhooks.
 com.ost.services.Webhooks webhooksService = services.webhooks;
 ```
 
-Get Webhooks Detail:
-
-```java
-HashMap<String, Object> params = new HashMap<String, Object>();
-params.put("webhook_id", "4107e308-0146-4c6f-b2f3-617e2c0d2354");
-JsonObject response = webhooksService.get( params );
-System.out.println("response: " + response.toString() );
-```
-
 Create Webhook:
 
 ```java
@@ -606,16 +597,16 @@ JsonObject response = webhooksService.update( params );
 System.out.println("response: " + response.toString() );
 ```
 
-Delete Webhook:
+Get Webhook:
 
 ```java
 HashMap<String, Object> params = new HashMap<String, Object>();
 params.put("webhook_id", "4107e308-0146-4c6f-b2f3-617e2c0d2354");
-JsonObject response = webhooksService.deleteWebhook( params );
+JsonObject response = webhooksService.get( params );
 System.out.println("response: " + response.toString() );
 ```
 
-List Webhooks Detail:
+Get Webhook List:
 
 ```java
 HashMap<String, Object> params = new HashMap<String, Object>();
@@ -625,14 +616,31 @@ JsonObject response = webhooksService.getList( params );
 System.out.println("response: " + response.toString() );
 ```
 
-Verify Signature for webhook:
+Delete Webhook:
+
+```java
+HashMap<String, Object> params = new HashMap<String, Object>();
+params.put("webhook_id", "4107e308-0146-4c6f-b2f3-617e2c0d2354");
+JsonObject response = webhooksService.deleteWebhook( params );
+System.out.println("response: " + response.toString() );
+```
+
+Verify webhook request signature:
 
 ```java
-String version = "v2"; // webhook response version should be here
-String stringifiedData = "YourStringifiedObjectData" // webhook response should be here
-String requestTimestamp = "1559902637"; // webhook response requested_timestamp should be here
+String webhookEventData = '{"id":"54e3cd1c-afd7-4dcf-9c78-137c56a53582","topic":"transactions/success","created_at":1560838772,"webhook_id":"0823a4ea-5d87-44cf-8ca8-1e5a31bf8e46","version":"v2","data":{"result_type":"transaction","transaction":{"id":"ddebe817-b94f-4b51-9227-f543fae4715a","transaction_hash":"0x7ee737db22b58dc4da3f4ea4830ca709b388d84f31e77106cb79ee09fc6448f9","from":"0x69a581096dbddf6d1e0fff7ebc1254bb7a2647c6","to":"0xc2f0dde92f6f3a3cb13bfff43e2bd136f7dcfe47","nonce":3,"value":"0","gas_price":"1000000000","gas_used":120558,"transaction_fee":"120558000000000","block_confirmation":24,"status":"SUCCESS","updated_timestamp":1560838699,"block_timestamp":1560838698,"block_number":1554246,"rule_name":"Pricer","meta_property":{},"transfers":[{"from":"0xc2f0dde92f6f3a3cb13bfff43e2bd136f7dcfe47","from_user_id":"acfdea7d-278e-4ffc-aacb-4a21398a280c","to":"0x0a754aaab96d634337aac6556312de396a0ca46a","to_user_id":"7bc8e0bd-6761-4604-8f8e-e33f86f81309","amount":"112325386","kind":"transfer"}]}}}' // webhook response should be here
+
+// Get webhoook version from webhook events data.
+String version = "v2";
+
+// Get ost-timestamp from the response received in event.
+String requestTimestamp = "1559902637";
+
+// Get signature from the response received in event.
 String signature = "e9206f9feecccd8f9653a4bdb56ea74531e6528bae8f6de1797aa77dc5235923";
+
 String webhookSecret = "09121ae7614856777fa36d63aca828e0ef14be77fb48fa149e0c0b50fec847a7";
+String stringifiedData = webhookEventData;
 Boolean response = webhooksService.verifySignature( version, stringifiedData, requestTimestamp, signature, webhookSecret );
 System.out.println("response: " + response );
 ```