|
63 | 63 | - [Local Server](#local-server) |
64 | 64 | - [Cloud Server](#cloud-server) |
65 | 65 | - [Webhooks](#webhooks) |
| 66 | + - [Supported Events](#supported-events) |
| 67 | + - [Setting Up Webhooks](#setting-up-webhooks) |
66 | 68 | - [Roadmap](#roadmap) |
67 | 69 | - [Contributing](#contributing) |
68 | 70 | - [License](#license) |
@@ -91,6 +93,7 @@ SMS Gateway turns your Android smartphone into an SMS gateway. It's a lightweigh |
91 | 93 | - 📊 **Message status tracking:** Monitor the status of sent messages in real-time. |
92 | 94 | - 🔔 **Real-time incoming message notifications:** Receive instant SMS and MMS notifications via webhooks. |
93 | 95 | - 📖 **Read received messages:** Access [previously received messages](https://docs.sms-gate.app/features/reading-messages/) via the same webhooks used for real-time notifications. |
| 96 | +- 📎 **MMS download notifications:** Receive webhook notifications when MMS messages are fully downloaded, including message body and attachments. |
94 | 97 |
|
95 | 98 | 🔒 Security and Privacy: |
96 | 99 |
|
@@ -237,6 +240,21 @@ For further privacy, you can deploy your own private server. See the [Private Se |
237 | 240 |
|
238 | 241 | Use webhooks to receive notifications for messaging events (e.g., incoming SMS and MMS). |
239 | 242 |
|
| 243 | +#### Supported Events |
| 244 | + |
| 245 | +| Event | Description | |
| 246 | +| ------------------- | --------------------------------------------------------------------------- | |
| 247 | +| `sms:received` | Triggered when an SMS message is received | |
| 248 | +| `sms:sent` | Triggered when an SMS message is sent | |
| 249 | +| `sms:delivered` | Triggered when an SMS message is delivered | |
| 250 | +| `sms:failed` | Triggered when an SMS message fails to send | |
| 251 | +| `sms:data-received` | Triggered when a data SMS is received | |
| 252 | +| `mms:received` | Triggered when an MMS notification is received (before download) | |
| 253 | +| `mms:downloaded` | Triggered when an MMS message is fully downloaded with body and attachments | |
| 254 | +| `system:ping` | Periodic heartbeat event | |
| 255 | + |
| 256 | +#### Setting Up Webhooks |
| 257 | + |
240 | 258 | Follow these steps to set up webhooks: |
241 | 259 |
|
242 | 260 | 1. Set up your own HTTP server with a valid SSL certificate to receive webhooks. For testing purposes, [webhook.site](https://webhook.site) can be useful. |
|
0 commit comments