https://github.com/seven-io/grav-form-notification
Grav CMS plugin for sending SMS or making text-to-speech call after form submission
https://github.com/seven-io/grav-form-notification
grav grav-plugin sms text-to-speech
Last synced: 23 days ago
JSON representation
Grav CMS plugin for sending SMS or making text-to-speech call after form submission
- Host: GitHub
- URL: https://github.com/seven-io/grav-form-notification
- Owner: seven-io
- License: mit
- Created: 2021-09-22T11:02:00.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2023-12-15T13:22:16.000Z (over 2 years ago)
- Last Synced: 2025-02-25T00:37:20.899Z (over 1 year ago)
- Topics: grav, grav-plugin, sms, text-to-speech
- Language: PHP
- Homepage: https://www.seven.io
- Size: 6.84 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
seven Form Notification for Grav
Send SMS or text-to-speech calls every time a Grav form is submitted.
---
## Features
- **Form-Triggered SMS / Voice** - Notify the form owner and/or the submitting user on every submission
- **Field Placeholders** - Use `{{FORM_NAME}}` and any submitted form field in the message body
- **Per-Form Override** - Configure recipient, sender and message globally, then override per Grav form
## Prerequisites
- [Grav CMS](https://getgrav.org/)
- A [seven account](https://www.seven.io/) with API key ([How to get your API key](https://help.seven.io/en/developer/where-do-i-find-my-api-key))
## Installation
### Via Grav Package Manager (recommended)
```bash
bin/gpm install sms77-form-notification
```
The plugin lands in `/user/plugins/sms77-form-notification`.
### Manually
1. Download the [latest release](https://github.com/seven-io/grav-form-notification/releases/latest) ZIP.
2. Unpack it into `/path/to/grav/user/plugins`.
3. Rename the resulting folder to `sms77-form-notification`.
## Configuration
Copy the default config so it survives plugin updates:
```bash
cp user/plugins/sms77-form-notification/sms77-form-notification.yaml \
user/config/plugins/sms77-form-notification.yaml
```
Edit the file:
```yaml
api_key: your-seven-api-key # seven.io API key
enable_notification_user: true # message the user-supplied phone field
enable_notification: true # message the static "to" recipient
enabled: true # plugin master switch
from: Grav # custom sender name/number
message: 'You just received a new submission for your form named {{FORM_NAME}}.'
msg_type: sms # sms or voice
phone_field: mobile_phone # form field that holds the user's phone number
to: +491771783130 # operator's phone number
user_response_msg: 'Thanks for your form submission.'
```
## Usage
Create or edit any [Grav form](https://learn.getgrav.org/forms). On every submission the plugin sends notifications according to your configuration. Form fields can be referenced in the message via `{{FIELD_NAME}}`.
## Support
Need help? Feel free to [contact us](https://www.seven.io/en/company/contact/) or [open an issue](https://github.com/seven-io/grav-form-notification/issues).
## License
[MIT](LICENSE)