diff options
Diffstat (limited to 'SCHEMA.md')
| -rw-r--r-- | SCHEMA.md | 13 |
1 files changed, 8 insertions, 5 deletions
@@ -16,10 +16,10 @@ In this document: | ------------- | ----------------------------------------- | ----------------------------------------------------------------------------------------- | ---------------------------------------- | | `id` | Unique identifier | A user selected, unique, descriptive identifier (used in URL routes, so no spaces) | `"ban-appeals"` | | `features` | List of [form features](#form-features) | A list of features to change the behaviour of the form, described in the features section | `["OPEN", "COLLECT_EMAIL"]` | -| `meta` | Mapping of [meta options](#meta-options) | Meta properties for the form. | See meta-options section | | `questions` | List of [form questions](#form-question) | The list of questions to render on a specific form | Too long! See below | | `name` | String | Name of the form | `"Summer Code Jam 2100"` | | `description` | String | Form description | `"This is my amazing form description."` | +| `webhook` | [Webhook object](#webhooks) | An optional discord webhook. | See webhook documentation. | ### Form features @@ -32,10 +32,13 @@ In this document: | `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. | -### Meta options -| Field | Description | Example | -| --------- | ---------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------ | -| `webhook` | Mapping of webhook url and message. Message can use certain [context variables](#webhook-variables). | `"webhook": {"url": "https://discord.com/api/webhooks/id/key", "message": "{user} submitted a form."}` | +### Webhooks +Discord webhooks to send information upon form submission. + +| Field | Type | Description | +| ----------| ------ | --------------------------------------------------------------------------------------------------------- | +| `url` | String | Discord webhook URL. | +| `message` | String | An optional message to include before the embed. Can use certain [context variables](#webhook-variables). | #### Webhook Variables |