Merge pull request #113 from tigrisdata/object-notifications

Object notifications doc fixes

Author: garrensmith

docs/buckets/object_notifications.md renamed to docs/buckets/object-notifications.md

@@ -4,10 +4,10 @@ Tigris object notifications allow you to receive notifications via a webhook.
 These events allow you to keep track of when objects are created, updated, or
 deleted for a specific bucket.
 
-## Enable Object Notifications via Console (TODO)
+## Enable Object Notifications via Tigris Dashboard
 
 To enable object notifications, you need to set up a webhook in the Tigris
-Console. This can be done in `Settings` for the bucket.
+Dashboard. This can be done in `Settings` for the bucket.
 
 Here's a short video demonstration on enabling object notifications:
 
@@ -19,12 +19,12 @@ Here's a short video demonstration on enabling object notifications:
 
 Object notifications are delivered via a webhook, and obey the following rules:
 
-- Tigris will make an HTTP POST post request to the webhook URL with the event
+- Tigris will make an HTTP POST request to the webhook URL with the event
   payload.
 - A `200` status code acknowledges the request was successful.
 - If a `200` status is not received, Tigris will retry for a maximum of 3 times
   before giving up and marking the notifications as sent.
-- If a webhook request takes longer than 5 seconds the request will be aborted
+- If a webhook request takes longer than 10 seconds the request will be aborted
   and retried.
 
 ## Webhook Authentication
@@ -60,7 +60,7 @@ Each notification will be a JSON object with the following fields:
 
 | Property     | Type   | Description                                                  |
 | ------------ | ------ | ------------------------------------------------------------ |
-| Records      | Array  | An array of notification events                              |
+| events       | Array  | An array of notification events                              |
 | eventVersion | String | Version of the event structure                               |
 | eventSource  | String | Source of the event                                          |
 | eventName    | String | Type of event (e.g., "OBJECT_CREATED_PUT", "OBJECT_DELETED") |
@@ -75,7 +75,7 @@ An example notification payload is:
 
 ```json
 {
-  "Records": [
+  "events": [
     {
       "eventVersion": "1",
       "eventSource": "tigris",

docs/pricing/index.md

@@ -157,8 +157,6 @@ storage.
 
 </details>
 
-### Events
-
 <details>
 <summary>What is an event and how are they charged?</summary>
 

docs/sdks/s3/aws-go-sdk.md

@@ -467,11 +467,11 @@ func main() {
 ## Webhook
 
 Below is an example of how to use
-[webhook](/docs/buckets/object_notifications.md) with the AWS Go SDK.
+[webhook](/docs/buckets/object-notifications.md) with the AWS Go SDK.
 
 ```go
 type ObjectNotificationReq struct {
-	Records []*ObjectNotificationEvent `json:"Records"`
+	Events []*ObjectNotificationEvent `json:"events"`
 }
 
 type ObjectNotificationEvent struct {
@@ -505,8 +505,8 @@ func eventReceiver(w http.ResponseWriter, r *http.Request) {
 	}
 
 	fmt.Println("Events:")
-	for _, record := range req.Records {
-		fmt.Printf("time: %v, event: %v, bucket: %v, key: %v\n", record.EventTime, record.EventName, record.Bucket, record.Object.Key)
+	for _, event := range req.Events {
+		fmt.Printf("time: %v, event: %v, bucket: %v, key: %v\n", event.EventTime, event.EventName, event.Bucket, event.Object.Key)
 	}
 
 	fmt.Fprint(w, "ok")

sidebars.js

@@ -60,7 +60,7 @@ const sidebars = {
         "buckets/cors",
         "buckets/custom-domain",
         "buckets/objects-expiration",
-        "buckets/object_notifications",
+        "buckets/object-notifications",
       ],
     },
     {