aboutsummaryrefslogtreecommitdiffstats
path: root/SCHEMA.md
diff options
context:
space:
mode:
authorGravatar Hassan Abouelela <[email protected]>2021-03-16 15:54:56 +0300
committerGravatar GitHub <[email protected]>2021-03-16 15:54:56 +0300
commit43935e9f19faa271dc134510e940542276b3a050 (patch)
treee04f8f27fc026f0fc35918a465767280663cbc1a /SCHEMA.md
parentMerge pull request #72 from python-discord/dependabot/pip/httpx-0.17.1 (diff)
parentMerge branch 'main' into ks123/role-assigning (diff)
Merge pull request #49 from python-discord/ks123/role-assigning
Implement Discord roles assigning for form submissions
Diffstat (limited to 'SCHEMA.md')
-rw-r--r--SCHEMA.md2
1 files changed, 2 insertions, 0 deletions
diff --git a/SCHEMA.md b/SCHEMA.md
index ada828e..9d89188 100644
--- a/SCHEMA.md
+++ b/SCHEMA.md
@@ -21,6 +21,7 @@ In this document:
| `description` | String | Form description | `"This is my amazing form description."` |
| `webhook` | [Webhook object](#webhooks) | An optional discord webhook. | See webhook documentation. |
| `submitted_text` | Optional[String] | An optional string for the response upon submitting. | `"This is my amazing form response."` |
+| `discord_role` | String (optional) | Discord role ID what will be assigned, required when `ASSIGN_ROLE` flag provided. | `784467518298259466` |
### Form features
@@ -32,6 +33,7 @@ In this document:
| `COLLECT_EMAIL` | The form should collect the email from submissions. Requires `REQUIRES_LOGIN` |
| `DISABLE_ANTISPAM` | Disable the anti-spam checks from running on a form submission. |
| `WEBHOOK_ENABLED` | The form should notify the webhook. Has no effect if no webhook is set. |
+| `ASSIGN_ROLE` | The form should assign role to user. Requires `REQUIRES_LOGIN`. |
### Webhooks
Discord webhooks to send information upon form submission.