Skip to content

Commit c1682a7

Browse files
committed
[docs] update README
1 parent 5253364 commit c1682a7

1 file changed

Lines changed: 18 additions & 0 deletions

File tree

README.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -63,6 +63,8 @@
6363
- [Local Server](#local-server)
6464
- [Cloud Server](#cloud-server)
6565
- [Webhooks](#webhooks)
66+
- [Supported Events](#supported-events)
67+
- [Setting Up Webhooks](#setting-up-webhooks)
6668
- [Roadmap](#roadmap)
6769
- [Contributing](#contributing)
6870
- [License](#license)
@@ -91,6 +93,7 @@ SMS Gateway turns your Android smartphone into an SMS gateway. It's a lightweigh
9193
- 📊 **Message status tracking:** Monitor the status of sent messages in real-time.
9294
- 🔔 **Real-time incoming message notifications:** Receive instant SMS and MMS notifications via webhooks.
9395
- 📖 **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.
9497

9598
🔒 Security and Privacy:
9699

@@ -237,6 +240,21 @@ For further privacy, you can deploy your own private server. See the [Private Se
237240

238241
Use webhooks to receive notifications for messaging events (e.g., incoming SMS and MMS).
239242

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+
240258
Follow these steps to set up webhooks:
241259

242260
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

Comments
 (0)