Skip to content

Instantly share code, notes, and snippets.

Embed
What would you like to do?
Java DiscordWebhook class to easily execute Discord Webhooks
import javax.net.ssl.HttpsURLConnection;
import java.awt.Color;
import java.io.IOException;
import java.io.OutputStream;
import java.lang.reflect.Array;
import java.net.URL;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Set;
/**
* Class used to execute Discord Webhooks with low effort
*/
public class DiscordWebhook {
private final String url;
private String content;
private String username;
private String avatarUrl;
private boolean tts;
private List<EmbedObject> embeds = new ArrayList<>();
/**
* Constructs a new DiscordWebhook instance
*
* @param url The webhook URL obtained in Discord
*/
public DiscordWebhook(String url) {
this.url = url;
}
public void setContent(String content) {
this.content = content;
}
public void setUsername(String username) {
this.username = username;
}
public void setAvatarUrl(String avatarUrl) {
this.avatarUrl = avatarUrl;
}
public void setTts(boolean tts) {
this.tts = tts;
}
public void addEmbed(EmbedObject embed) {
this.embeds.add(embed);
}
public void execute() throws IOException {
if (this.content == null && this.embeds.isEmpty()) {
throw new IllegalArgumentException("Set content or add at least one EmbedObject");
}
JSONObject json = new JSONObject();
json.put("content", this.content);
json.put("username", this.username);
json.put("avatar_url", this.avatarUrl);
json.put("tts", this.tts);
if (!this.embeds.isEmpty()) {
List<JSONObject> embedObjects = new ArrayList<>();
for (EmbedObject embed : this.embeds) {
JSONObject jsonEmbed = new JSONObject();
jsonEmbed.put("title", embed.getTitle());
jsonEmbed.put("description", embed.getDescription());
jsonEmbed.put("url", embed.getUrl());
if (embed.getColor() != null) {
Color color = embed.getColor();
int rgb = color.getRed();
rgb = (rgb << 8) + color.getGreen();
rgb = (rgb << 8) + color.getBlue();
jsonEmbed.put("color", rgb);
}
EmbedObject.Footer footer = embed.getFooter();
EmbedObject.Image image = embed.getImage();
EmbedObject.Thumbnail thumbnail = embed.getThumbnail();
EmbedObject.Author author = embed.getAuthor();
List<EmbedObject.Field> fields = embed.getFields();
if (footer != null) {
JSONObject jsonFooter = new JSONObject();
jsonFooter.put("text", footer.getText());
jsonFooter.put("icon_url", footer.getIconUrl());
jsonEmbed.put("footer", jsonFooter);
}
if (image != null) {
JSONObject jsonImage = new JSONObject();
jsonImage.put("url", image.getUrl());
jsonEmbed.put("image", jsonImage);
}
if (thumbnail != null) {
JSONObject jsonThumbnail = new JSONObject();
jsonThumbnail.put("url", thumbnail.getUrl());
jsonEmbed.put("thumbnail", jsonThumbnail);
}
if (author != null) {
JSONObject jsonAuthor = new JSONObject();
jsonAuthor.put("name", author.getName());
jsonAuthor.put("url", author.getUrl());
jsonAuthor.put("icon_url", author.getIconUrl());
jsonEmbed.put("author", jsonAuthor);
}
List<JSONObject> jsonFields = new ArrayList<>();
for (EmbedObject.Field field : fields) {
JSONObject jsonField = new JSONObject();
jsonField.put("name", field.getName());
jsonField.put("value", field.getValue());
jsonField.put("inline", field.isInline());
jsonFields.add(jsonField);
}
jsonEmbed.put("fields", jsonFields.toArray());
embedObjects.add(jsonEmbed);
}
json.put("embeds", embedObjects.toArray());
}
URL url = new URL(this.url);
HttpsURLConnection connection = (HttpsURLConnection) url.openConnection();
connection.addRequestProperty("Content-Type", "application/json");
connection.addRequestProperty("User-Agent", "Java-DiscordWebhook-BY-Gelox_");
connection.setDoOutput(true);
connection.setRequestMethod("POST");
OutputStream stream = connection.getOutputStream();
stream.write(json.toString().getBytes());
stream.flush();
stream.close();
connection.getInputStream().close(); //I'm not sure why but it doesn't work without getting the InputStream
connection.disconnect();
}
public static class EmbedObject {
private String title;
private String description;
private String url;
private Color color;
private Footer footer;
private Thumbnail thumbnail;
private Image image;
private Author author;
private List<Field> fields = new ArrayList<>();
public String getTitle() {
return title;
}
public String getDescription() {
return description;
}
public String getUrl() {
return url;
}
public Color getColor() {
return color;
}
public Footer getFooter() {
return footer;
}
public Thumbnail getThumbnail() {
return thumbnail;
}
public Image getImage() {
return image;
}
public Author getAuthor() {
return author;
}
public List<Field> getFields() {
return fields;
}
public EmbedObject setTitle(String title) {
this.title = title;
return this;
}
public EmbedObject setDescription(String description) {
this.description = description;
return this;
}
public EmbedObject setUrl(String url) {
this.url = url;
return this;
}
public EmbedObject setColor(Color color) {
this.color = color;
return this;
}
public EmbedObject setFooter(String text, String icon) {
this.footer = new Footer(text, icon);
return this;
}
public EmbedObject setThumbnail(String url) {
this.thumbnail = new Thumbnail(url);
return this;
}
public EmbedObject setImage(String url) {
this.image = new Image(url);
return this;
}
public EmbedObject setAuthor(String name, String url, String icon) {
this.author = new Author(name, url, icon);
return this;
}
public EmbedObject addField(String name, String value, boolean inline) {
this.fields.add(new Field(name, value, inline));
return this;
}
private class Footer {
private String text;
private String iconUrl;
private Footer(String text, String iconUrl) {
this.text = text;
this.iconUrl = iconUrl;
}
private String getText() {
return text;
}
private String getIconUrl() {
return iconUrl;
}
}
private class Thumbnail {
private String url;
private Thumbnail(String url) {
this.url = url;
}
private String getUrl() {
return url;
}
}
private class Image {
private String url;
private Image(String url) {
this.url = url;
}
private String getUrl() {
return url;
}
}
private class Author {
private String name;
private String url;
private String iconUrl;
private Author(String name, String url, String iconUrl) {
this.name = name;
this.url = url;
this.iconUrl = iconUrl;
}
private String getName() {
return name;
}
private String getUrl() {
return url;
}
private String getIconUrl() {
return iconUrl;
}
}
private class Field {
private String name;
private String value;
private boolean inline;
private Field(String name, String value, boolean inline) {
this.name = name;
this.value = value;
this.inline = inline;
}
private String getName() {
return name;
}
private String getValue() {
return value;
}
private boolean isInline() {
return inline;
}
}
}
private class JSONObject {
private final HashMap<String, Object> map = new HashMap<>();
void put(String key, Object value) {
if (value != null) {
map.put(key, value);
}
}
@Override
public String toString() {
StringBuilder builder = new StringBuilder();
Set<Map.Entry<String, Object>> entrySet = map.entrySet();
builder.append("{");
int i = 0;
for (Map.Entry<String, Object> entry : entrySet) {
Object val = entry.getValue();
builder.append(quote(entry.getKey())).append(":");
if (val instanceof String) {
builder.append(quote(String.valueOf(val)));
} else if (val instanceof Integer) {
builder.append(Integer.valueOf(String.valueOf(val)));
} else if (val instanceof Boolean) {
builder.append(val);
} else if (val instanceof JSONObject) {
builder.append(val.toString());
} else if (val.getClass().isArray()) {
builder.append("[");
int len = Array.getLength(val);
for (int j = 0; j < len; j++) {
builder.append(Array.get(val, j).toString()).append(j != len - 1 ? "," : "");
}
builder.append("]");
}
builder.append(++i == entrySet.size() ? "}" : ",");
}
return builder.toString();
}
private String quote(String string) {
return "\"" + string + "\"";
}
}
}
@k3kdude

This comment has been minimized.

Copy link
Owner Author

@k3kdude k3kdude commented Aug 17, 2017

Example usage:

    DiscordWebhook webhook = new DiscordWebhook("https://discordapp.com/api/webhooks/...");
    webhook.setContent("Any message!");
    webhook.setAvatarUrl("https://your.awesome/image.png");
    webhook.setUsername("Custom Usernames!");
    webhook.setTts(true);
    webhook.addEmbed(new DiscordWebhook.EmbedObject()
            .setTitle("Title")
            .setDescription("This is a description")
            .setColor(Color.RED)
            .addField("1st Field", "Inline", true)
    .addField("2nd Field", "Inline", true)
    .addField("3rd Field", "No-Inline", false)
    .setThumbnail("https://kryptongta.com/images/kryptonlogo.png")
    .setFooter("Footer text", "https://kryptongta.com/images/kryptonlogodark.png")
    .setImage("https://kryptongta.com/images/kryptontitle2.png")
    .setAuthor("Author Name", "https://kryptongta.com", "https://kryptongta.com/images/kryptonlogowide.png")
    .setUrl("https://kryptongta.com"));
    webhook.addEmbed(new DiscordWebhook.EmbedObject()
    .setDescription("Just another added embed object!"));
    webhook.execute(); //Handle exception

Will give the following result:
result

@DarkEyeDragon

This comment has been minimized.

Copy link

@DarkEyeDragon DarkEyeDragon commented Nov 10, 2018

This works great! Using this in a Minecraft mod that does stuff with images. And this way makes it so easy to post the results in Discord.
Thanks for the gist.

@ParadauxDev

This comment has been minimized.

Copy link

@ParadauxDev ParadauxDev commented May 25, 2019

Does this still work? Having issues with it for use with Spigot.

@christophernarciso

This comment has been minimized.

Copy link

@christophernarciso christophernarciso commented May 31, 2019

Thanks for this helper class!

@nkomarn

This comment has been minimized.

Copy link

@nkomarn nkomarn commented Jun 15, 2019

Does this still work? Having issues with it for use with Spigot.

Still works!

@SpencerSharkey

This comment has been minimized.

Copy link

@SpencerSharkey SpencerSharkey commented Jul 13, 2019

Beware that this doesn't escape the JSON strings, so you'll have to do that yourself.

@Bonfire

This comment has been minimized.

Copy link

@Bonfire Bonfire commented Aug 25, 2019

Thank you very much for this helper class. Works wonderfully!

@GMatrixGames

This comment has been minimized.

Copy link

@GMatrixGames GMatrixGames commented Nov 24, 2019

I get a 400 HTTP error when using this after 1 time.

@RedstonecraftHD

This comment has been minimized.

Copy link

@RedstonecraftHD RedstonecraftHD commented Dec 12, 2019

It works with my Minecraft Plugin! Thank you!

@Wirlie

This comment has been minimized.

Copy link

@Wirlie Wirlie commented Feb 26, 2020

I get a 400 HTTP error when using this after 1 time.

In my case, I get a 400 HTTP error because I have used UTF-8 characters, to solve that I have changed this line:
https://gist.github.com/k3kdude/fba6f6b37594eae3d6f9475330733bdb#file-discordwebhook-java-L148

with:

stream.write(json.toString().getBytes(StandardCharsets.UTF_8));
@AbdulRIsmail

This comment has been minimized.

Copy link

@AbdulRIsmail AbdulRIsmail commented May 12, 2020

How can I pass an image from the same directory?

Exception in thread "main" java.io.IOException: Server returned HTTP response code: 400 for URL: https://discordapp.com/api/webhooks/hookurl
	at sun.net.www.protocol.http.HttpURLConnection.getInputStream0(HttpURLConnection.java:1894)
	at sun.net.www.protocol.http.HttpURLConnection.getInputStream(HttpURLConnection.java:1492)
	at sun.net.www.protocol.https.HttpsURLConnectionImpl.getInputStream(HttpsURLConnectionImpl.java:263)
	at DiscordWebhook.execute(DiscordWebhook.java:152)
	at WebHook.main(WebHook.java:30)

The line that's causing it

.setImage("data/file.jpg"));
@Jaimss

This comment has been minimized.

Copy link

@Jaimss Jaimss commented Aug 6, 2020

Anyone using kotlin: https://gist.github.com/Jaimss/42fed5695f5bfb6a3282abe8bfc7c229#file-discordwebhook-kt
I forked this and sorta made it in kotlin. It's working for me, but if you got issues comment on it and ill fix them

@ZombieCloud

This comment has been minimized.

Copy link

@ZombieCloud ZombieCloud commented Aug 19, 2020

It's just works !!!

@pmp94

This comment has been minimized.

Copy link

@pmp94 pmp94 commented Nov 16, 2020

Hey, can someone help me out please. Where should I run Example usage? Thanks

@scswskid

This comment has been minimized.

Copy link

@scswskid scswskid commented Nov 19, 2020

is there a way to send a file

@DoNotHaveAnIdeaForAUsername

This comment has been minimized.

Copy link

@DoNotHaveAnIdeaForAUsername DoNotHaveAnIdeaForAUsername commented Jan 5, 2021

This was helpful allot, thank you!

@InstFurry

This comment has been minimized.

Copy link

@InstFurry InstFurry commented Mar 26, 2021

It's very nice class, thank you! But I have a problem with sending cyrilic characters - it gives BAD REQUEST error qwo

@faderook

This comment has been minimized.

Copy link

@faderook faderook commented Mar 30, 2021

nice

@Feniksovich

This comment has been minimized.

Copy link

@Feniksovich Feniksovich commented May 4, 2021

Works perfect, thank you!

For other users: be sure you creating the DiscordWebhook object (message) inside the method and you won't get errors like
Cannot resolve method 'addField' in '*Classname*'.

@Dogloverblue17

This comment has been minimized.

Copy link

@Dogloverblue17 Dogloverblue17 commented May 21, 2021

I can't get this to work? I wanted to use the example they provided, but I can't find where to put it, whatever I do, I just get the error Syntax error on token ".", @ expected after this token Does anyone know a fix for this?
Edit: Solved, I was being dumb and forgot to add main

@Dimflix

This comment has been minimized.

Copy link

@Dimflix Dimflix commented Jun 6, 2021

God bless you

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment