Merge pull request #177 from notificationapi-com/OHBV5uaK/3175-webhook-doc

Update webhook documentation to include detailed failure event types

Author: mbasadi

docs/features/events-webhook.md

@@ -45,19 +45,24 @@ You can easily configure your webhook endpoints and select which events to track
 
 The webhook currently supports the following notification events:
 
-| Event         | Description                                                           | Payload                                                                                                  |
-| ------------- | --------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- |
-| `EMAIL_OPEN`  | Triggered when a recipient opens an email notification                | `{ eventType: "OPEN", trackingId: string, notificationId: string, channel: "EMAIL", userId: string }`    |
-| `EMAIL_CLICK` | Triggered when a recipient clicks a link in an email notification     | `{ eventType: "CLICK", trackingId: string, notificationId: string, channel: "EMAIL", userId: string }`   |
-| `FAILED`      | Triggered when a notification fails to deliver (for any channel type) | `{ eventType: "FAILED", trackingId: string, notificationId: string, channel: Channels, userId: string }` |
+| Event              | Description                                                       | Payload                                                                                                               |
+| ------------------ | ----------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- |
+| `EMAIL_OPEN`       | Triggered when a recipient opens an email notification            | `{ eventType: "OPEN", trackingId: string, notificationId: string, channel: "EMAIL", userId: string }`                 |
+| `EMAIL_CLICK`      | Triggered when a recipient clicks a link in an email notification | `{ eventType: "CLICK", trackingId: string, notificationId: string, channel: "EMAIL", userId: string }`                |
+| `EMAIL_FAILED`     | Triggered when an email notification fails to deliver             | `{ eventType: "EMAIL_FAILED", trackingId: string, notificationId: string, channel: "EMAIL", userId: string }`         |
+| `SMS_FAILED`       | Triggered when an SMS notification fails to deliver               | `{ eventType: "SMS_FAILED", trackingId: string, notificationId: string, channel: "SMS", userId: string }`             |
+| `CALL_FAILED`      | Triggered when a call notification fails                          | `{ eventType: "CALL_FAILED", trackingId: string, notificationId: string, channel: "CALL", userId: string }`           |
+| `PUSH_FAILED`      | Triggered when a mobile push notification fails to deliver        | `{ eventType: "PUSH_FAILED", trackingId: string, notificationId: string, channel: "PUSH", userId: string }`           |
+| `WEB_PUSH_FAILED`  | Triggered when a web push notification fails to deliver           | `{ eventType: "WEB_PUSH_FAILED", trackingId: string, notificationId: string, channel: "WEB_PUSH", userId: string }`   |
+| `INAPP_WEB_FAILED` | Triggered when an in-app web notification fails to deliver        | `{ eventType: "INAPP_WEB_FAILED", trackingId: string, notificationId: string, channel: "INAPP_WEB", userId: string }` |
 
 ## Setting Up Your Webhook
 
 To receive notification events:
 
 1. Create a publicly accessible API endpoint that can receive HTTP POST requests
 2. Configure your webhook URL in the NotificationAPI dashboard
-3. Select which events you want to receive (EMAIL_OPEN, EMAIL_CLICK, FAILED)
+3. Select which events you want to receive (EMAIL_OPEN, EMAIL_CLICK, EMAIL_FAILED, SMS_FAILED, etc.)
 4. Implement proper validation of incoming webhook requests
 5. Process and store the event data as needed for your use case
 
@@ -67,13 +72,13 @@ To receive notification events:
 A: Webhook requests are sent as HTTP POST requests with JSON payloads containing event details such as eventType, trackingId, notificationId, channel, and userId.
 
 **Q: Can I filter which events I receive?**  
-A: Yes, you can select which events to receive (EMAIL_OPEN, EMAIL_CLICK, FAILED) in the dashboard configuration.
+A: Yes, you can select which events to receive (EMAIL_OPEN, EMAIL_CLICK, EMAIL_FAILED, SMS_FAILED, etc.) in the dashboard configuration.
 
 **Q: What response should my endpoint return?**  
 A: Your endpoint should return a 2xx HTTP status code to acknowledge successful receipt of the webhook.
 
-**Q: When would I receive a FAILED event?**  
-A: You'll receive a FAILED event whenever a notification on any channel (email, SMS, push, etc.) fails to deliver to the recipient. This could happen for various reasons like invalid recipient details, network issues, service provider failures, or user-specific delivery problems. This event helps you track delivery failures across all your notification channels.
+**Q: When would I receive failure events?**  
+A: You'll receive channel-specific failure events (EMAIL_FAILED, SMS_FAILED, CALL_FAILED, etc.) whenever a notification fails to deliver through the respective channel. This could happen for various reasons like invalid recipient details, network issues, service provider failures, or user-specific delivery problems. These events help you track delivery failures across specific notification channels.
 
 **Q: Can I delete or update my webhook configuration?**  
 A: Yes, you can update your webhook URL or selected events at any time from the dashboard. You can also delete your webhook configuration if you no longer need it.