Skip to content

[webhooks] add FastAPI example link #85

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Apr 15, 2025
Merged

[webhooks] add FastAPI example link #85

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions docs/features/webhooks.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -113,6 +113,8 @@ Your server will receive a POST request with a payload like:
!!! important "Timely Response"
Your server **must** respond with a 2xx status within 30 seconds to prevent retries

#### Retry Policy

The app implements an exponential backoff retry strategy: it waits 10 seconds before the first retry, then 20 seconds, 40 seconds, and so on, doubling the interval each time. By default, the app will retry 14 times (approximately 2 days) before giving up. You can specify a custom retry count in the app's **Settings > Webhooks**.

### Step 6: Deregister a Webhook 🗑️
Expand Down Expand Up @@ -246,5 +248,6 @@ Remember to adhere to best practices for security and perform thorough testing t

## Examples 💡

- [FastAPI webhook processor](https://github.com/android-sms-gateway/example-webhooks-fastapi): Demonstrates registration, HMAC validation, and payload handling.
- [Telegram Forwarder Function](https://github.com/android-sms-gateway/example-telegram-forwarder-fn): Forwards SMS to Telegram using a cloud function.
- [Web Client](https://github.com/android-sms-gateway/web-client-ts): Node.js client for sending/receiving SMS via Socket.io.
1 change: 1 addition & 0 deletions docs/resources/examples.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ In this section, you will find links to examples related to this project. We do

### Official Examples

- [FastAPI webhook processor](https://github.com/android-sms-gateway/example-webhooks-fastapi) - A FastAPI app that demonstrates registration, HMAC validation, and payload handling.
- [Discord Forwarder Function](https://github.com/android-sms-gateway/example-discord-forwarder-fn) - A Cloud Function to seamlessly forward SMS messages to a Discord server using webhooks.
- [Telegram Forwarder Function](https://github.com/android-sms-gateway/example-telegram-forwarder-fn) - A Cloud Function to seamlessly forward SMS messages to a Telegram chat using webhooks.
- [Web Client](https://github.com/android-sms-gateway/web-client-ts) - Simple web client for sending and receiving SMS messages based on Node.js and Socket.io.
Expand Down