This documentation serves to demonstrate how to use SAMMI - Discord Webhook Helper
Setup
To get started, the included deck comes with 2 big buttons, Add Webhook and Remove Webhook. You will need to use these buttons to save webhooks for use in other commnads.
Once you've added atleast 1 webhook, you can start making buttons to send messages to these webhooks. There are 2 example decks that show some basic use cases for creating stylised embeds.
Discord WH: Add Webhook
Saves a webhook under a readable name for use in other commands that can send data to webhooks.
| Field | Description |
|---|---|
| Webhook Name | The name you would like to save your webhook Url under |
| Webhook Url | The URL you want to be associated with the name of the webhook |
Discord WH: Remove Webhook
Removes a saved webhook from the command list. You will need to go around to other commands that used this webhook and change it, as it will no longer work.
| Field | Description |
|---|---|
| Webhook Name | The saved webhook you would like to delete |
SAMMI Commands
Discord WH: Send Message
| Field | Description |
|---|---|
| Webhook Name | The name of the Webhook you'd like the send a message via |
| Message | The message you would like to have sent to discord |
Discord WH: Builder
In order to prevent having 15~ odd extension commands, all the builder commands are consolidated into command options. While it makes it a little annoying when trying to find commands, it saves having to bloat, the already bloated extension commands.
| Field | Description |
|---|---|
| Option | Allows you to select a new command in its place.Discord WH: Message BuilderDiscord WH: Embed Builder |
Discord WH: Message Builder
Creates a builder object which you use to build a discord message.
| Field | Description |
|---|---|
| (Optional) Profile Name |
Changes the profile name of the webhook posting the content |
| (Optional) Icon Url |
Changes the profile picture of the webhook posting the content |
| Save Variable As | The variable name the builder should get returned as (waiting not required) |
Discord WH: Message Content
Sets the message content of the discord message.
| Field | Description |
|---|---|
| Builder Name | The name of the builder object (use Message Builder to get a builder) |
| Text Content | The text content of the webhook message. 2000 characters max. |
Discord WH: Add File
Adds up to 10 files to your discord message.
| Field | Description |
|---|---|
| Builder Name | The name of the builder object (use Message Builder to get a builder) |
| File Path | The path on your computer where the file could be located. |
Discord WH: Add Embed
Adds an embed object to your message builder. You can add multiple embeds but I'm not sure what the limit is.
| Field | Description |
|---|---|
| Builder Name | The name of the builder you want to add an embed to. |
| Embed Name | The name of the embed builder you want to add to your message builder. |
Discord WH: Obs Take Screenshot
Takes a screenshot in Obs and adds it to your builder Object. You can optionally save the attachment url to use in an embed.
| Field | Description |
|---|---|
| Builder Name | The name of the builder you want to add an embed to. |
| Source | The name of the source/scene you want to take a screenshot of. |
| Save Attachment As | The variable you wish to save the returned URL as. This can be used in an embed image url like /$variableName$/ |
Discord WH: Embed Builder
Creates an embed builder object which you use to build embedded messages for use in a message builder.
| Field | Description |
|---|---|
| Title | The title of the embedded message |
| Color (hex) | Color in hex. The # gets removed, so you dont need to worry about cleaning it up |
| Save Variable As | The variable name the embed builder should get returned as (waiting not required) |
Discord WH: Embed Content
Sets the content of the embed
| Field | Description |
|---|---|
| Embed Builder | The name of the embed builder you want to set the content of |
| Embed Message | The message you want to set in the Embed |
Discord WH: Embed Author
Sets the Author of an embed (different from the bot profile name/picture)
| Field | Description |
|---|---|
| Embed Builder | The name of the embed builder you want to set the content of |
| (optional) Author Name |
The name of the Author |
| (optional) Author Icon Url |
The Icon url of the Author |
| (optional) Author Url |
The redirect url of the Author |
Discord WH: Add Field
Adds a new field (title/paragraph) to your Embed. You can add multiple fields to your Embed, but I'm not sure what the limit is. Field Title and Message are mandatory if you add them.
| Field | Description |
|---|---|
| Embed Builder | The name of the embed builder you want to set the content of |
| Field Name | The title of the Field |
| Field Message | The message content of the field |
Discord WH: Add Image
Sets an image on your Embed. This only supports image media. You can use external links, or uploaded media from Discord WH: Add File, you just need to reference the name and extension of the file. (Only one image is supported on an embed)
| Field | Description |
|---|---|
| Embed Builder | The name of the embed builder you want to set the content of |
| Image Url | The Url of an image you wish to use. If you uploaded files earlier, you can also use these by typing attachment://<file_name>If I uploaded a file called Hello.png I would use attachment://Hello.pngThis can also be used for an Obs screenshot, you just need to reference the returned url variable like so /$variable$/, depending on what you called it. |
| (optional) Thumbnail Url |
The thumbnail of the image |
Discord WH: Add Footer
Sets the footer content
| Field | Description |
|---|---|
| Embed Builder | The name of the embed builder you want to set the footer content of |
| Footer Text | Short text of what you want displayed in the footer |
| Footer Icon Url | Small icon you want displayed next to your footer |
| Include Timestamp | Shows a timestamp next to your footer |