CAS-5564/Add webhooks docs (#97)

Maria Korlotian · web-flow · commit 1f4651cc63bd · 2021-01-19T11:54:15.000+01:00
diff --git a/README.rst b/README.rst
@@ -17,7 +17,7 @@ Installation
 Configuration
 -------------
 
-import and configure the library with your Castle API secret.
+Import and configure the library with your Castle API secret.
 
 .. code:: python
 
@@ -231,6 +231,20 @@ Exceptions
 level HTTP response. You can also choose to catch a more `finegrained
 error <https://github.com/castle/castle-python/blob/master/castle/errors.py>`__.
 
+Webhooks
+--------
+
+Castle uses webhooks to notify about ``$incident.confirmed`` or `$review.opened` events.
+Each webhook has ``X-Castle-Signature`` header that allows verifying webhook's source.
+
+.. code:: python
+
+    from castle.webhooks.verify import WebhooksVerify
+
+    # Verify the webhook, passed as a Request object
+    WebhooksVerify.call(webhook_request)
+    # WebhookVerificationError is raised when the signature is not matching
+
 Documentation
 -------------
 
