Package net.dv8tion.jda.api.entities

Interface WebhookClient<T>

All Superinterfaces:

ISnowflake

All Known Subinterfaces:

IncomingWebhookClient, InteractionHook, Webhook

All Known Implementing Classes:

AbstractWebhookClient, IncomingWebhookClientImpl, InteractionHookImpl, WebhookImpl

public interface WebhookClient<T>
extends ISnowflake

Interface which allows sending messages through the webhooks API.
Interactions can use these through IDeferrableCallback.getHook().

See Also:

• Webhook
• InteractionHook

Method Summary

Modifier and Type	Method	Description
static IncomingWebhookClient	createClient(JDA api, String url)	Creates an instance of IncomingWebhookClient capable of executing webhook requests.
static IncomingWebhookClient	createClient(JDA api, String webhookId, String webhookToken)	Creates an instance of IncomingWebhookClient capable of executing webhook requests.
default WebhookMessageDeleteAction	deleteMessageById(long messageId)	Delete a message from this webhook.
WebhookMessageDeleteAction	deleteMessageById(String messageId)	Delete a message from this webhook.
default WebhookMessageEditAction<T>	editMessageAttachmentsById(long messageId, Collection<? extends AttachedFile> attachments)	Edit an existing message sent by this webhook.
default WebhookMessageEditAction<T>	editMessageAttachmentsById(long messageId, AttachedFile... attachments)	Edit an existing message sent by this webhook.
WebhookMessageEditAction<T>	editMessageAttachmentsById(String messageId, Collection<? extends AttachedFile> attachments)	Edit an existing message sent by this webhook.
default WebhookMessageEditAction<T>	editMessageAttachmentsById(String messageId, AttachedFile... attachments)	Edit an existing message sent by this webhook.
default WebhookMessageEditAction<T>	editMessageById(long messageId, String content)	Edit an existing message sent by this webhook.
default WebhookMessageEditAction<T>	editMessageById(long messageId, MessageEditData message)	Edit an existing message sent by this webhook.
WebhookMessageEditAction<T>	editMessageById(String messageId, String content)	Edit an existing message sent by this webhook.
WebhookMessageEditAction<T>	editMessageById(String messageId, MessageEditData message)	Edit an existing message sent by this webhook.
default WebhookMessageEditAction<T>	editMessageComponentsById(long messageId, Collection<? extends MessageTopLevelComponent> components)	Edit an existing message sent by this webhook.
default WebhookMessageEditAction<T>	editMessageComponentsById(long messageId, MessageTopLevelComponent... components)	Edit an existing message sent by this webhook.
default WebhookMessageEditAction<T>	editMessageComponentsById(long messageId, ComponentTree<? extends MessageTopLevelComponent> tree)	Edit an existing message sent by this webhook.
WebhookMessageEditAction<T>	editMessageComponentsById(String messageId, Collection<? extends MessageTopLevelComponent> components)	Edit an existing message sent by this webhook.
default WebhookMessageEditAction<T>	editMessageComponentsById(String messageId, MessageTopLevelComponent... components)	Edit an existing message sent by this webhook.
default WebhookMessageEditAction<T>	editMessageComponentsById(String messageId, ComponentTree<? extends MessageTopLevelComponent> tree)	Edit an existing message sent by this webhook.
default WebhookMessageEditAction<T>	editMessageEmbedsById(long messageId, Collection<? extends MessageEmbed> embeds)	Edit an existing message sent by this webhook.
default WebhookMessageEditAction<T>	editMessageEmbedsById(long messageId, MessageEmbed... embeds)	Edit an existing message sent by this webhook.
WebhookMessageEditAction<T>	editMessageEmbedsById(String messageId, Collection<? extends MessageEmbed> embeds)	Edit an existing message sent by this webhook.
default WebhookMessageEditAction<T>	editMessageEmbedsById(String messageId, MessageEmbed... embeds)	Edit an existing message sent by this webhook.
default WebhookMessageEditAction<T>	editMessageFormatById(long messageId, String format, Object... args)	Edit an existing message sent by this webhook.
default WebhookMessageEditAction<T>	editMessageFormatById(String messageId, String format, Object... args)	Edit an existing message sent by this webhook.
JDA	getJDA()	The associated JDA instance.
String	getToken()	The token of this webhook.
WebhookMessageRetrieveAction	retrieveMessageById(String messageId)	Retrieves the message with the provided id.
WebhookMessageCreateAction<T>	sendFiles(Collection<? extends FileUpload> files)	Send a message to this webhook.
default WebhookMessageCreateAction<T>	sendFiles(FileUpload... files)	Send a message to this webhook.
WebhookMessageCreateAction<T>	sendMessage(String content)	Send a message to this webhook.
WebhookMessageCreateAction<T>	sendMessage(MessageCreateData message)	Send a message to this webhook.
WebhookMessageCreateAction<T>	sendMessageComponents(Collection<? extends MessageTopLevelComponent> components)	Send a message to this webhook.
default WebhookMessageCreateAction<T>	sendMessageComponents(MessageTopLevelComponent component, MessageTopLevelComponent... other)	Send a message to this webhook.
default WebhookMessageCreateAction<T>	sendMessageComponents(ComponentTree<? extends MessageTopLevelComponent> tree)	Send a message to this webhook.
WebhookMessageCreateAction<T>	sendMessageEmbeds(Collection<? extends MessageEmbed> embeds)	Send a message to this webhook.
default WebhookMessageCreateAction<T>	sendMessageEmbeds(MessageEmbed embed, MessageEmbed... embeds)	Send a message to this webhook.
default WebhookMessageCreateAction<T>	sendMessageFormat(String format, Object... args)	Send a message to this webhook.
WebhookMessageCreateAction<T>	sendMessagePoll(MessagePollData poll)	Send a message poll to this webhook.

Methods inherited from interface net.dv8tion.jda.api.entities.ISnowflake

getId, getIdLong, getTimeCreated

Method Details

getToken

@Nullable
String getToken()

The token of this webhook.

Returns:

The token, or null if this webhook does not have a token available

getJDA

@Nonnull
JDA getJDA()

The associated JDA instance.

Returns:

The JDA instance

sendMessage

@Nonnull
@CheckReturnValue
WebhookMessageCreateAction<T> sendMessage(@Nonnull
 String content)

Send a message to this webhook.

If this is an InteractionHook this method will be delayed until the interaction is acknowledged.

Possible ErrorResponses include:

• UNKNOWN_WEBHOOK
  The webhook is no longer available, either it was deleted or in case of interactions it expired.
• MAX_FOLLOW_UP_MESSAGES_HIT
  If this is an InteractionHook and you sent more than 5 follow ups in a guild the bot isn't in.
• MESSAGE_BLOCKED_BY_AUTOMOD
  If this message was blocked by an AutoModRule
• MESSAGE_BLOCKED_BY_HARMFUL_LINK_FILTER
  If this message was blocked by the harmful link filter

Parameters:

content - The message content

Returns:

WebhookMessageCreateAction

Throws:

IllegalArgumentException - If the content is null or longer than Message.MAX_CONTENT_LENGTH characters

sendMessage

@Nonnull
@CheckReturnValue
WebhookMessageCreateAction<T> sendMessage(@Nonnull
 MessageCreateData message)

Send a message to this webhook.

If this is an InteractionHook this method will be delayed until the interaction is acknowledged.

Possible ErrorResponses include:

• UNKNOWN_WEBHOOK
  The webhook is no longer available, either it was deleted or in case of interactions it expired.
• MAX_FOLLOW_UP_MESSAGES_HIT
  If this is an InteractionHook and you sent more than 5 follow ups in an interaction using only IntegrationType.USER_INSTALL.
• MESSAGE_BLOCKED_BY_AUTOMOD
  If this message was blocked by an AutoModRule
• MESSAGE_BLOCKED_BY_HARMFUL_LINK_FILTER
  If this message was blocked by the harmful link filter

Parameters:

message - The MessageCreateData to send

Returns:

WebhookMessageCreateAction

Throws:

IllegalArgumentException - If null is provided

See Also:

• MessageCreateBuilder

sendMessagePoll

@Nonnull
@CheckReturnValue
WebhookMessageCreateAction<T> sendMessagePoll(@Nonnull
 MessagePollData poll)

Send a message poll to this webhook.

If this is an InteractionHook this method will be delayed until the interaction is acknowledged.

Possible ErrorResponses include:

• UNKNOWN_WEBHOOK
  The webhook is no longer available, either it was deleted or in case of interactions it expired.
• MAX_FOLLOW_UP_MESSAGES_HIT
  If this is an InteractionHook and you sent more than 5 follow ups in a guild the bot isn't in.
• MESSAGE_BLOCKED_BY_AUTOMOD
  If this message was blocked by an AutoModRule
• MESSAGE_BLOCKED_BY_HARMFUL_LINK_FILTER
  If this message was blocked by the harmful link filter
• POLL_INVALID_CHANNEL_TYPE
  This channel does not allow polls
• POLL_WITH_UNUSABLE_EMOJI
  This poll uses an external emoji that the bot is not allowed to use

Parameters:

poll - The MessagePollData to send

Returns:

WebhookMessageCreateAction

Throws:

IllegalArgumentException - If null is provided

See Also:

• MessagePollBuilder

sendMessageFormat

@Nonnull
@CheckReturnValue
default WebhookMessageCreateAction<T> sendMessageFormat(@Nonnull
 String format,
 @Nonnull
 Object... args)

Send a message to this webhook.

If this is an InteractionHook this method will be delayed until the interaction is acknowledged.

Possible ErrorResponses include:

• UNKNOWN_WEBHOOK
  The webhook is no longer available, either it was deleted or in case of interactions it expired.
• MAX_FOLLOW_UP_MESSAGES_HIT
  If this is an InteractionHook and you sent more than 5 follow ups in a guild the bot isn't in.
• MESSAGE_BLOCKED_BY_AUTOMOD
  If this message was blocked by an AutoModRule
• MESSAGE_BLOCKED_BY_HARMFUL_LINK_FILTER
  If this message was blocked by the harmful link filter

Parameters:

format - Format string for the message content

args - Format arguments for the content

Returns:

WebhookMessageCreateAction

Throws:

IllegalArgumentException - If the format string is null or the resulting content is longer than Message.MAX_CONTENT_LENGTH characters

sendMessageEmbeds

@Nonnull
@CheckReturnValue
WebhookMessageCreateAction<T> sendMessageEmbeds(@Nonnull
 Collection<? extends MessageEmbed> embeds)

Send a message to this webhook.

If this is an InteractionHook this method will be delayed until the interaction is acknowledged.

Possible ErrorResponses include:

• UNKNOWN_WEBHOOK
  The webhook is no longer available, either it was deleted or in case of interactions it expired.
• MAX_FOLLOW_UP_MESSAGES_HIT
  If this is an InteractionHook and you sent more than 5 follow ups in a guild the bot isn't in.
• MESSAGE_BLOCKED_BY_AUTOMOD
  If this message was blocked by an AutoModRule
• MESSAGE_BLOCKED_BY_HARMFUL_LINK_FILTER
  If this message was blocked by the harmful link filter

Example: Attachment Images

 // Make a file upload instance which refers to a local file called "myFile.png"
 // The second parameter "image.png" is the filename we tell discord to use for the attachment
 FileUpload file = FileUpload.fromData(new File("myFile.png"), "image.png");

 // Build a message embed which refers to this attachment by the given name.
 // Note that this must be the same name as configured for the attachment, not your local filename.
 MessageEmbed embed = new EmbedBuilder()
   .setDescription("This is my cute cat :)")
   .setImage("attachment://image.png") // refer to the file by using the "attachment://" schema with the filename we gave it above
   .build();

 webhook.sendMessageEmbeds(Collections.singleton(embed)) // send the embeds
        .addFiles(file) // add the file as attachment
        .queue();
 

Parameters:

embeds - MessageEmbeds to use (up to 10)

Returns:

WebhookMessageCreateAction

Throws:

IllegalArgumentException - If any of the embeds are null, more than 10, or longer than MessageEmbed.EMBED_MAX_LENGTH_BOT.

sendMessageEmbeds

@Nonnull
@CheckReturnValue
default WebhookMessageCreateAction<T> sendMessageEmbeds(@Nonnull
 MessageEmbed embed,
 @Nonnull
 MessageEmbed... embeds)

Send a message to this webhook.

If this is an InteractionHook this method will be delayed until the interaction is acknowledged.

Possible ErrorResponses include:

• UNKNOWN_WEBHOOK
  The webhook is no longer available, either it was deleted or in case of interactions it expired.
• MAX_FOLLOW_UP_MESSAGES_HIT
  If this is an InteractionHook and you sent more than 5 follow ups in a guild the bot isn't in.
• MESSAGE_BLOCKED_BY_AUTOMOD
  If this message was blocked by an AutoModRule
• MESSAGE_BLOCKED_BY_HARMFUL_LINK_FILTER
  If this message was blocked by the harmful link filter

Example: Attachment Images

 // Make a file upload instance which refers to a local file called "myFile.png"
 // The second parameter "image.png" is the filename we tell discord to use for the attachment
 FileUpload file = FileUpload.fromData(new File("myFile.png"), "image.png");

 // Build a message embed which refers to this attachment by the given name.
 // Note that this must be the same name as configured for the attachment, not your local filename.
 MessageEmbed embed = new EmbedBuilder()
   .setDescription("This is my cute cat :)")
   .setImage("attachment://image.png") // refer to the file by using the "attachment://" schema with the filename we gave it above
   .build();

 webhook.sendMessageEmbeds(embed) // send the embed
        .addFiles(file) // add the file as attachment
        .queue();
 

Parameters:

embed - MessageEmbed to use

embeds - Additional MessageEmbeds to use (up to 10 in total)

Returns:

WebhookMessageCreateAction

Throws:

IllegalArgumentException - If any of the embeds are null, more than 10, or longer than MessageEmbed.EMBED_MAX_LENGTH_BOT.

sendMessageComponents

@Nonnull
@CheckReturnValue
WebhookMessageCreateAction<T> sendMessageComponents(@Nonnull
 Collection<? extends MessageTopLevelComponent> components)

Send a message to this webhook.

If this is an InteractionHook this method will be delayed until the interaction is acknowledged.

Possible ErrorResponses include:

• UNKNOWN_WEBHOOK
  The webhook is no longer available, either it was deleted or in case of interactions it expired.
• MAX_FOLLOW_UP_MESSAGES_HIT
  If this is an InteractionHook and you sent more than 5 follow ups in a guild the bot isn't in.
• MESSAGE_BLOCKED_BY_AUTOMOD
  If this message was blocked by an AutoModRule
• MESSAGE_BLOCKED_BY_HARMFUL_LINK_FILTER
  If this message was blocked by the harmful link filter

Parameters:

components - The MessageTopLevelComponents to send, can contain up to 5 V1 components. There are no limits for V2 components outside the total tree size (40).

Returns:

WebhookMessageCreateAction

Throws:

IllegalArgumentException -

• If null is provided
• If any of the provided components are not compatible with messages

sendMessageComponents

@Nonnull
@CheckReturnValue
default WebhookMessageCreateAction<T> sendMessageComponents(@Nonnull
 MessageTopLevelComponent component,
 @Nonnull
 MessageTopLevelComponent... other)

Send a message to this webhook.

If this is an InteractionHook this method will be delayed until the interaction is acknowledged.

Possible ErrorResponses include:

• UNKNOWN_WEBHOOK
  The webhook is no longer available, either it was deleted or in case of interactions it expired.
• MAX_FOLLOW_UP_MESSAGES_HIT
  If this is an InteractionHook and you sent more than 5 follow ups in a guild the bot isn't in.
• MESSAGE_BLOCKED_BY_AUTOMOD
  If this message was blocked by an AutoModRule
• MESSAGE_BLOCKED_BY_HARMFUL_LINK_FILTER
  If this message was blocked by the harmful link filter

Parameters:

component - The MessageTopLevelComponent to send

other - Additional MessageTopLevelComponents to send, can contain up to 5 V1 components. There are no limits for V2 components outside the total tree size (40).

Returns:

WebhookMessageCreateAction

Throws:

IllegalArgumentException -

• If null is provided
• If any of the provided components are not compatible with messages

sendMessageComponents

@Nonnull
@CheckReturnValue
default WebhookMessageCreateAction<T> sendMessageComponents(@Nonnull
 ComponentTree<? extends MessageTopLevelComponent> tree)

Send a message to this webhook.

If this is an InteractionHook this method will be delayed until the interaction is acknowledged.

Possible ErrorResponses include:

• UNKNOWN_WEBHOOK
  The webhook is no longer available, either it was deleted or in case of interactions it expired.
• MAX_FOLLOW_UP_MESSAGES_HIT
  If this is an InteractionHook and you sent more than 5 follow ups in a guild the bot isn't in.
• MESSAGE_BLOCKED_BY_AUTOMOD
  If this message was blocked by an AutoModRule
• MESSAGE_BLOCKED_BY_HARMFUL_LINK_FILTER
  If this message was blocked by the harmful link filter

Parameters:

tree - The ComponentTree to send, containing up to 5 V1 components. There are no limits for V2 components outside the total tree size (40).

Returns:

WebhookMessageCreateAction

Throws:

IllegalArgumentException -

• If null is provided
• If any of the provided components are not compatible with messages

See Also:

• MessageComponentTree

sendFiles

@Nonnull
@CheckReturnValue
WebhookMessageCreateAction<T> sendFiles(@Nonnull
 Collection<? extends FileUpload> files)

Send a message to this webhook.

If this is an InteractionHook this method will be delayed until the interaction is acknowledged.

Resource Handling Note: Once the request is handed off to the requester, for example when you call RestAction.queue(), the requester will automatically clean up all opened files by itself. You are only responsible to close them yourself if it is never handed off properly. For instance, if an exception occurs after using FileUpload.fromData(File), before calling RestAction.queue(). You can safely use a try-with-resources to handle this, since FileUpload.close() becomes ineffective once the request is handed off.

Example: Attachment Images

 // Make a file upload instance which refers to a local file called "myFile.png"
 // The second parameter "image.png" is the filename we tell discord to use for the attachment
 FileUpload file = FileUpload.fromData(new File("myFile.png"), "image.png");

 // Build a message embed which refers to this attachment by the given name.
 // Note that this must be the same name as configured for the attachment, not your local filename.
 MessageEmbed embed = new EmbedBuilder()
   .setDescription("This is my cute cat :)")
   .setImage("attachment://image.png") // refer to the file by using the "attachment://" schema with the filename we gave it above
   .build();

 webhook.sendFiles(Collections.singleton(file)) // send the file upload
        .addEmbeds(embed) // add the embed you want to reference the file with
        .queue();
 

Possible ErrorResponses include:

• UNKNOWN_WEBHOOK
  The webhook is no longer available, either it was deleted or in case of interactions it expired.
• MAX_FOLLOW_UP_MESSAGES_HIT
  If this is an InteractionHook and you sent more than 5 follow ups in a guild the bot isn't in.
• MESSAGE_BLOCKED_BY_AUTOMOD
  If this message was blocked by an AutoModRule
• MESSAGE_BLOCKED_BY_HARMFUL_LINK_FILTER
  If this message was blocked by the harmful link filter
• REQUEST_ENTITY_TOO_LARGE
  If the total sum of uploaded bytes exceeds the guild's upload limit

Parameters:

files - The FileUploads to attach to the message

Returns:

WebhookMessageCreateAction

Throws:

IllegalArgumentException - If null is provided

See Also:

• FileUpload.fromData(InputStream, String)

sendFiles

@Nonnull
@CheckReturnValue
default WebhookMessageCreateAction<T> sendFiles(@Nonnull
 FileUpload... files)

Send a message to this webhook.

If this is an InteractionHook this method will be delayed until the interaction is acknowledged.

Resource Handling Note: Once the request is handed off to the requester, for example when you call RestAction.queue(), the requester will automatically clean up all opened files by itself. You are only responsible to close them yourself if it is never handed off properly. For instance, if an exception occurs after using FileUpload.fromData(File), before calling RestAction.queue(). You can safely use a try-with-resources to handle this, since FileUpload.close() becomes ineffective once the request is handed off.

Example: Attachment Images

 // Make a file upload instance which refers to a local file called "myFile.png"
 // The second parameter "image.png" is the filename we tell discord to use for the attachment
 FileUpload file = FileUpload.fromData(new File("myFile.png"), "image.png");

 // Build a message embed which refers to this attachment by the given name.
 // Note that this must be the same name as configured for the attachment, not your local filename.
 MessageEmbed embed = new EmbedBuilder()
   .setDescription("This is my cute cat :)")
   .setImage("attachment://image.png") // refer to the file by using the "attachment://" schema with the filename we gave it above
   .build();

 webhook.sendFiles(file) // send the file upload
        .addEmbeds(embed) // add the embed you want to reference the file with
        .queue();
 

Possible ErrorResponses include:

• UNKNOWN_WEBHOOK
  The webhook is no longer available, either it was deleted or in case of interactions it expired.
• MAX_FOLLOW_UP_MESSAGES_HIT
  If this is an InteractionHook and you sent more than 5 follow ups in a guild the bot isn't in.
• MESSAGE_BLOCKED_BY_AUTOMOD
  If this message was blocked by an AutoModRule
• MESSAGE_BLOCKED_BY_HARMFUL_LINK_FILTER
  If this message was blocked by the harmful link filter
• REQUEST_ENTITY_TOO_LARGE
  If the total sum of uploaded bytes exceeds the guild's upload limit

Parameters:

files - The FileUploads to attach to the message

Returns:

WebhookMessageCreateAction

Throws:

IllegalArgumentException - If null is provided

See Also:

• FileUpload.fromData(InputStream, String)

editMessageById

@Nonnull
@CheckReturnValue
WebhookMessageEditAction<T> editMessageById(@Nonnull
 String messageId,
 @Nonnull
 String content)

Edit an existing message sent by this webhook.

If this is an InteractionHook this method will be delayed until the interaction is acknowledged.

Possible ErrorResponses include:

• UNKNOWN_WEBHOOK
  The webhook is no longer available, either it was deleted or in case of interactions it expired.
• UNKNOWN_MESSAGE
  The message for that id does not exist
• INVALID_FORM_BODY
  Components V2 is used by the to-be-edited message, and this request has non-empty content or embeds.

Parameters:

messageId - The message id. For interactions this supports "@original" to edit the source message of the interaction.

content - The new message content to use

Returns:

WebhookMessageEditAction

Throws:

IllegalArgumentException - If the provided content is null or longer than Message.MAX_CONTENT_LENGTH characters

editMessageById

@Nonnull
@CheckReturnValue
default WebhookMessageEditAction<T> editMessageById(long messageId,
 @Nonnull
 String content)

Edit an existing message sent by this webhook.

If this is an InteractionHook this method will be delayed until the interaction is acknowledged.

Possible ErrorResponses include:

• UNKNOWN_WEBHOOK
  The webhook is no longer available, either it was deleted or in case of interactions it expired.
• UNKNOWN_MESSAGE
  The message for that id does not exist
• INVALID_FORM_BODY
  Components V2 is used by the to-be-edited message, and this request has non-empty content or embeds.

Parameters:

messageId - The message id. For interactions this supports "@original" to edit the source message of the interaction.

content - The new message content to use

Returns:

WebhookMessageEditAction

Throws:

IllegalArgumentException - If the provided content is null or longer than Message.MAX_CONTENT_LENGTH characters

editMessageById

@Nonnull
@CheckReturnValue
WebhookMessageEditAction<T> editMessageById(@Nonnull
 String messageId,
 @Nonnull
 MessageEditData message)

Edit an existing message sent by this webhook.

If this is an InteractionHook this method will be delayed until the interaction is acknowledged.

Possible ErrorResponses include:

• UNKNOWN_WEBHOOK
  The webhook is no longer available, either it was deleted or in case of interactions it expired.
• UNKNOWN_MESSAGE
  The message for that id does not exist
• INVALID_FORM_BODY
  Components V2 is used by the to-be-edited message, and this request has non-empty content or embeds.

Parameters:

messageId - The message id. For interactions this supports "@original" to edit the source message of the interaction.

message - The MessageEditData containing the update information

Returns:

WebhookMessageEditAction

Throws:

IllegalArgumentException - If the provided message is null

See Also:

• MessageEditBuilder

editMessageById

@Nonnull
@CheckReturnValue
default WebhookMessageEditAction<T> editMessageById(long messageId,
 @Nonnull
 MessageEditData message)

Edit an existing message sent by this webhook.

If this is an InteractionHook this method will be delayed until the interaction is acknowledged.

Possible ErrorResponses include:

• UNKNOWN_WEBHOOK
  The webhook is no longer available, either it was deleted or in case of interactions it expired.
• UNKNOWN_MESSAGE
  The message for that id does not exist
• INVALID_FORM_BODY
  Components V2 is used by the to-be-edited message, and this request has non-empty content or embeds.

Parameters:

messageId - The message id. For interactions this supports "@original" to edit the source message of the interaction.

message - The MessageEditData containing the update information

Returns:

WebhookMessageEditAction

Throws:

IllegalArgumentException - If the provided message is null

See Also:

• MessageEditBuilder

editMessageFormatById

@Nonnull
@CheckReturnValue
default WebhookMessageEditAction<T> editMessageFormatById(@Nonnull
 String messageId,
 @Nonnull
 String format,
 @Nonnull
 Object... args)

Edit an existing message sent by this webhook.

If this is an InteractionHook this method will be delayed until the interaction is acknowledged.

Possible ErrorResponses include:

• UNKNOWN_WEBHOOK
  The webhook is no longer available, either it was deleted or in case of interactions it expired.
• UNKNOWN_MESSAGE
  The message for that id does not exist
• INVALID_FORM_BODY
  Components V2 is used by the to-be-edited message, and this request has non-empty content or embeds.

Parameters:

messageId - The message id. For interactions this supports "@original" to edit the source message of the interaction.

format - Format string for the message content

args - Format arguments for the content

Returns:

WebhookMessageEditAction

Throws:

IllegalArgumentException - If the formatted string is null or longer than Message.MAX_CONTENT_LENGTH characters

editMessageFormatById

@Nonnull
@CheckReturnValue
default WebhookMessageEditAction<T> editMessageFormatById(long messageId,
 @Nonnull
 String format,
 @Nonnull
 Object... args)

Edit an existing message sent by this webhook.

If this is an InteractionHook this method will be delayed until the interaction is acknowledged.

Possible ErrorResponses include:

• UNKNOWN_WEBHOOK
  The webhook is no longer available, either it was deleted or in case of interactions it expired.
• UNKNOWN_MESSAGE
  The message for that id does not exist
• INVALID_FORM_BODY
  Components V2 is used by the to-be-edited message, and this request has non-empty content or embeds.

Parameters:

messageId - The message id. For interactions this supports "@original" to edit the source message of the interaction.

format - Format string for the message content

args - Format arguments for the content

Returns:

WebhookMessageEditAction

Throws:

IllegalArgumentException - If the formatted string is null or longer than Message.MAX_CONTENT_LENGTH characters

editMessageEmbedsById

@Nonnull
@CheckReturnValue
WebhookMessageEditAction<T> editMessageEmbedsById(@Nonnull
 String messageId,
 @Nonnull
 Collection<? extends MessageEmbed> embeds)

Edit an existing message sent by this webhook.

If this is an InteractionHook this method will be delayed until the interaction is acknowledged.

Possible ErrorResponses include:

• UNKNOWN_WEBHOOK
  The webhook is no longer available, either it was deleted or in case of interactions it expired.
• UNKNOWN_MESSAGE
  The message for that id does not exist
• INVALID_FORM_BODY
  Components V2 is used by the to-be-edited message, and this request has non-empty content or embeds.

Parameters:

messageId - The message id. For interactions this supports "@original" to edit the source message of the interaction.

embeds - MessageEmbeds to use (up to 10 in total)

Returns:

WebhookMessageEditAction

Throws:

IllegalArgumentException - If null or more than 10 embeds are provided

editMessageEmbedsById

@Nonnull
@CheckReturnValue
default WebhookMessageEditAction<T> editMessageEmbedsById(long messageId,
 @Nonnull
 Collection<? extends MessageEmbed> embeds)

Edit an existing message sent by this webhook.

If this is an InteractionHook this method will be delayed until the interaction is acknowledged.

Possible ErrorResponses include:

• UNKNOWN_WEBHOOK
  The webhook is no longer available, either it was deleted or in case of interactions it expired.
• UNKNOWN_MESSAGE
  The message for that id does not exist
• INVALID_FORM_BODY
  Components V2 is used by the to-be-edited message, and this request has non-empty content or embeds.

Parameters:

messageId - The message id. For interactions this supports "@original" to edit the source message of the interaction.

embeds - MessageEmbeds to use (up to 10 in total)

Returns:

WebhookMessageEditAction

Throws:

IllegalArgumentException - If null or more than 10 embeds are provided

editMessageEmbedsById

@Nonnull
@CheckReturnValue
default WebhookMessageEditAction<T> editMessageEmbedsById(@Nonnull
 String messageId,
 @Nonnull
 MessageEmbed... embeds)

Edit an existing message sent by this webhook.

If this is an InteractionHook this method will be delayed until the interaction is acknowledged.

Possible ErrorResponses include:

• UNKNOWN_WEBHOOK
  The webhook is no longer available, either it was deleted or in case of interactions it expired.
• UNKNOWN_MESSAGE
  The message for that id does not exist
• INVALID_FORM_BODY
  Components V2 is used by the to-be-edited message, and this request has non-empty content or embeds.

Parameters:

messageId - The message id. For interactions this supports "@original" to edit the source message of the interaction.

embeds - The new MessageEmbeds to use

Returns:

WebhookMessageEditAction

Throws:

IllegalArgumentException - If null or more than 10 embeds are provided

editMessageEmbedsById

@Nonnull
@CheckReturnValue
default WebhookMessageEditAction<T> editMessageEmbedsById(long messageId,
 @Nonnull
 MessageEmbed... embeds)

Edit an existing message sent by this webhook.

If this is an InteractionHook this method will be delayed until the interaction is acknowledged.

Possible ErrorResponses include:

• UNKNOWN_WEBHOOK
  The webhook is no longer available, either it was deleted or in case of interactions it expired.
• UNKNOWN_MESSAGE
  The message for that id does not exist
• INVALID_FORM_BODY
  Components V2 is used by the to-be-edited message, and this request has non-empty content or embeds.

Parameters:

messageId - The message id. For interactions this supports "@original" to edit the source message of the interaction.

embeds - The new MessageEmbeds to use

Returns:

WebhookMessageEditAction

Throws:

IllegalArgumentException - If null or more than 10 embeds are provided

editMessageComponentsById

@Nonnull
@CheckReturnValue
WebhookMessageEditAction<T> editMessageComponentsById(@Nonnull
 String messageId,
 @Nonnull
 Collection<? extends MessageTopLevelComponent> components)

Edit an existing message sent by this webhook.

If this is an InteractionHook this method will be delayed until the interaction is acknowledged.

Possible ErrorResponses include:

• UNKNOWN_WEBHOOK
  The webhook is no longer available, either it was deleted or in case of interactions it expired.
• UNKNOWN_MESSAGE
  The message for that id does not exist
• INVALID_FORM_BODY
  Components V2 is used by the to-be-edited message, and this request has non-empty content or embeds.

Parameters:

messageId - The message id. For interactions this supports "@original" to edit the source message of the interaction.

components - The MessageTopLevelComponents to set, can be empty to remove components, can contain up to 5 V1 components. There are no limits for V2 components outside the total tree size (40).

Returns:

WebhookMessageEditAction

Throws:

IllegalArgumentException -

• If null is provided
• If any of the provided components are not compatible with messages

editMessageComponentsById

@Nonnull
@CheckReturnValue
default WebhookMessageEditAction<T> editMessageComponentsById(long messageId,
 @Nonnull
 Collection<? extends MessageTopLevelComponent> components)

Edit an existing message sent by this webhook.

If this is an InteractionHook this method will be delayed until the interaction is acknowledged.

Possible ErrorResponses include:

• UNKNOWN_WEBHOOK
  The webhook is no longer available, either it was deleted or in case of interactions it expired.
• UNKNOWN_MESSAGE
  The message for that id does not exist
• INVALID_FORM_BODY
  Components V2 is used by the to-be-edited message, and this request has non-empty content or embeds.

Parameters:

messageId - The message id. For interactions this supports "@original" to edit the source message of the interaction.

components - The MessageTopLevelComponents to set, can be empty to remove components, can contain up to 5 V1 components. There are no limits for V2 components outside the total tree size (40).

Returns:

WebhookMessageEditAction

Throws:

IllegalArgumentException -

• If null is provided
• If any of the provided components are not compatible with messages

editMessageComponentsById

@Nonnull
@CheckReturnValue
default WebhookMessageEditAction<T> editMessageComponentsById(@Nonnull
 String messageId,
 @Nonnull
 MessageTopLevelComponent... components)

Edit an existing message sent by this webhook.

If this is an InteractionHook this method will be delayed until the interaction is acknowledged.

Possible ErrorResponses include:

• UNKNOWN_WEBHOOK
  The webhook is no longer available, either it was deleted or in case of interactions it expired.
• UNKNOWN_MESSAGE
  The message for that id does not exist
• INVALID_FORM_BODY
  Components V2 is used by the to-be-edited message, and this request has non-empty content or embeds.

Parameters:

messageId - The message id. For interactions this supports "@original" to edit the source message of the interaction.

components - The MessageTopLevelComponents to set, can be empty to remove components, can contain up to 5 V1 components. There are no limits for V2 components outside the total tree size (40).

Returns:

WebhookMessageEditAction

Throws:

IllegalArgumentException -

• If null is provided
• If any of the provided components are not compatible with messages

editMessageComponentsById

@Nonnull
@CheckReturnValue
default WebhookMessageEditAction<T> editMessageComponentsById(long messageId,
 @Nonnull
 MessageTopLevelComponent... components)

Edit an existing message sent by this webhook.

If this is an InteractionHook this method will be delayed until the interaction is acknowledged.

Possible ErrorResponses include:

• UNKNOWN_WEBHOOK
  The webhook is no longer available, either it was deleted or in case of interactions it expired.
• UNKNOWN_MESSAGE
  The message for that id does not exist
• INVALID_FORM_BODY
  Components V2 is used by the to-be-edited message, and this request has non-empty content or embeds.

Parameters:

messageId - The message id. For interactions this supports "@original" to edit the source message of the interaction.

components - The MessageTopLevelComponents to set, can be empty to remove components, can contain up to 5 V1 components. There are no limits for V2 components outside the total tree size (40).

Returns:

WebhookMessageEditAction

Throws:

IllegalArgumentException -

• If null is provided
• If any of the provided components are not compatible with messages

editMessageComponentsById

@Nonnull
@CheckReturnValue
default WebhookMessageEditAction<T> editMessageComponentsById(@Nonnull
 String messageId,
 @Nonnull
 ComponentTree<? extends MessageTopLevelComponent> tree)

Edit an existing message sent by this webhook.

If this is an InteractionHook this method will be delayed until the interaction is acknowledged.

Possible ErrorResponses include:

• UNKNOWN_WEBHOOK
  The webhook is no longer available, either it was deleted or in case of interactions it expired.
• UNKNOWN_MESSAGE
  The message for that id does not exist
• INVALID_FORM_BODY
  Components V2 is used by the to-be-edited message, and this request has non-empty content or embeds.

Parameters:

messageId - The message id. For interactions this supports "@original" to edit the source message of the interaction.

tree - The ComponentTree to set, can be empty to remove components, can contain up to 5 V1 components. There are no limits for V2 components outside the total tree size (40).

Returns:

WebhookMessageEditAction

Throws:

IllegalArgumentException -

• If null is provided
• If any of the provided components are not compatible with messages

See Also:

• MessageComponentTree

editMessageComponentsById

@Nonnull
@CheckReturnValue
default WebhookMessageEditAction<T> editMessageComponentsById(long messageId,
 @Nonnull
 ComponentTree<? extends MessageTopLevelComponent> tree)

Edit an existing message sent by this webhook.

If this is an InteractionHook this method will be delayed until the interaction is acknowledged.

Possible ErrorResponses include:

• UNKNOWN_WEBHOOK
  The webhook is no longer available, either it was deleted or in case of interactions it expired.
• UNKNOWN_MESSAGE
  The message for that id does not exist
• INVALID_FORM_BODY
  Components V2 is used by the to-be-edited message, and this request has non-empty content or embeds.

Parameters:

messageId - The message id. For interactions this supports "@original" to edit the source message of the interaction.

tree - The ComponentTree to set, can be empty to remove components, can contain up to 5 V1 components. There are no limits for V2 components outside the total tree size (40).

Returns:

WebhookMessageEditAction

Throws:

IllegalArgumentException -

• If null is provided
• If any of the provided components are not compatible with messages

See Also:

• MessageComponentTree

editMessageAttachmentsById

@Nonnull
@CheckReturnValue
WebhookMessageEditAction<T> editMessageAttachmentsById(@Nonnull
 String messageId,
 @Nonnull
 Collection<? extends AttachedFile> attachments)

Edit an existing message sent by this webhook.

If this is an InteractionHook this method will be delayed until the interaction is acknowledged.

Resource Handling Note: Once the request is handed off to the requester, for example when you call RestAction.queue(), the requester will automatically clean up all opened files by itself. You are only responsible to close them yourself if it is never handed off properly. For instance, if an exception occurs after using FileUpload.fromData(File), before calling RestAction.queue(). You can safely use a try-with-resources to handle this, since FileUpload.close() becomes ineffective once the request is handed off.

Parameters:

messageId - The message id. For interactions this supports "@original" to edit the source message of the interaction.

attachments - The new attachments of the message (Can be FileUploads or AttachmentUpdates)

Returns:

MessageEditCallbackAction that can be used to further update the message

Throws:

IllegalArgumentException - If null is provided

See Also:

• AttachedFile.fromAttachment(Message.Attachment)
• FileUpload.fromData(InputStream, String)

editMessageAttachmentsById

@Nonnull
@CheckReturnValue
default WebhookMessageEditAction<T> editMessageAttachmentsById(@Nonnull
 String messageId,
 @Nonnull
 AttachedFile... attachments)

Edit an existing message sent by this webhook.

If this is an InteractionHook this method will be delayed until the interaction is acknowledged.

Resource Handling Note: Once the request is handed off to the requester, for example when you call RestAction.queue(), the requester will automatically clean up all opened files by itself. You are only responsible to close them yourself if it is never handed off properly. For instance, if an exception occurs after using FileUpload.fromData(File), before calling RestAction.queue(). You can safely use a try-with-resources to handle this, since FileUpload.close() becomes ineffective once the request is handed off.

Parameters:

messageId - The message id. For interactions this supports "@original" to edit the source message of the interaction.

attachments - The new attachments of the message (Can be FileUploads or AttachmentUpdates)

Returns:

MessageEditCallbackAction that can be used to further update the message

Throws:

IllegalArgumentException - If null is provided

See Also:

• AttachedFile.fromAttachment(Message.Attachment)
• FileUpload.fromData(InputStream, String)

editMessageAttachmentsById

@Nonnull
@CheckReturnValue
default WebhookMessageEditAction<T> editMessageAttachmentsById(long messageId,
 @Nonnull
 Collection<? extends AttachedFile> attachments)

Edit an existing message sent by this webhook.

If this is an InteractionHook this method will be delayed until the interaction is acknowledged.

Resource Handling Note: Once the request is handed off to the requester, for example when you call RestAction.queue(), the requester will automatically clean up all opened files by itself. You are only responsible to close them yourself if it is never handed off properly. For instance, if an exception occurs after using FileUpload.fromData(File), before calling RestAction.queue(). You can safely use a try-with-resources to handle this, since FileUpload.close() becomes ineffective once the request is handed off.

Parameters:

messageId - The message id. For interactions this supports "@original" to edit the source message of the interaction.

attachments - The new attachments of the message (Can be FileUploads or AttachmentUpdates)

Returns:

MessageEditCallbackAction that can be used to further update the message

Throws:

IllegalArgumentException - If null is provided

See Also:

• AttachedFile.fromAttachment(Message.Attachment)
• FileUpload.fromData(InputStream, String)

editMessageAttachmentsById

@Nonnull
@CheckReturnValue
default WebhookMessageEditAction<T> editMessageAttachmentsById(long messageId,
 @Nonnull
 AttachedFile... attachments)

Edit an existing message sent by this webhook.

If this is an InteractionHook this method will be delayed until the interaction is acknowledged.

Resource Handling Note: Once the request is handed off to the requester, for example when you call RestAction.queue(), the requester will automatically clean up all opened files by itself. You are only responsible to close them yourself if it is never handed off properly. For instance, if an exception occurs after using FileUpload.fromData(File), before calling RestAction.queue(). You can safely use a try-with-resources to handle this, since FileUpload.close() becomes ineffective once the request is handed off.

Parameters:

messageId - The message id. For interactions this supports "@original" to edit the source message of the interaction.

attachments - The new attachments of the message (Can be FileUploads or AttachmentUpdates)

Returns:

MessageEditCallbackAction that can be used to further update the message

Throws:

IllegalArgumentException - If null is provided

See Also:

• AttachedFile.fromAttachment(Message.Attachment)
• FileUpload.fromData(InputStream, String)

deleteMessageById

@Nonnull
@CheckReturnValue
WebhookMessageDeleteAction deleteMessageById(@Nonnull
 String messageId)

Delete a message from this webhook.

Use setThreadId(threadId) to delete messages from threads.

If this is an InteractionHook this method will be delayed until the interaction is acknowledged.

Possible ErrorResponses include:

• UNKNOWN_WEBHOOK
  The webhook is no longer available, either it was deleted or in case of interactions it expired.
• UNKNOWN_MESSAGE
  The message for that id does not exist

Parameters:

messageId - The id for the message to delete

Returns:

WebhookMessageDeleteAction

Throws:

IllegalArgumentException - If the provided message id is null or not a valid snowflake

deleteMessageById

@Nonnull
@CheckReturnValue
default WebhookMessageDeleteAction deleteMessageById(long messageId)

Delete a message from this webhook.

Use setThreadId(threadId) to delete messages from threads.

If this is an InteractionHook this method will be delayed until the interaction is acknowledged.

Possible ErrorResponses include:

• UNKNOWN_WEBHOOK
  The webhook is no longer available, either it was deleted or in case of interactions it expired.
• UNKNOWN_MESSAGE
  The message for that id does not exist

Parameters:

messageId - The id for the message to delete

Returns:

WebhookMessageDeleteAction

retrieveMessageById

@Nonnull
@CheckReturnValue
WebhookMessageRetrieveAction retrieveMessageById(@Nonnull
 String messageId)

Retrieves the message with the provided id.
This only works for messages sent by this webhook. All other messages are unknown.

Use setThreadId(threadId) to retrieve messages from threads.

If this is an InteractionHook this method will be delayed until the interaction is acknowledged.

Possible ErrorResponses include:

• UNKNOWN_WEBHOOK
  The webhook is no longer available, either it was deleted or in case of interactions it expired.
• UNKNOWN_MESSAGE
  If the message is inaccessible to this webhook or does not exist.

Returns:

WebhookMessageRetrieveAction

createClient

@Nonnull
static IncomingWebhookClient createClient(@Nonnull
 JDA api,
 @Nonnull
 String url)

Creates an instance of IncomingWebhookClient capable of executing webhook requests.

Messages created by this client may not have a fully accessible channel or guild available. The messages might report a channel of type UNKNOWN, in which case the channel is assumed to be inaccessible and limited to only webhook requests.

Parameters:

api - The JDA instance, used to handle rate-limits

url - The webhook url, must include a webhook token

Returns:

The IncomingWebhookClient instance

Throws:

IllegalArgumentException - If null is provided or the provided url is not a valid webhook url

See Also:

• InteractionHook.from(JDA, String)

createClient

@Nonnull
static IncomingWebhookClient createClient(@Nonnull
 JDA api,
 @Nonnull
 String webhookId,
 @Nonnull
 String webhookToken)

Creates an instance of IncomingWebhookClient capable of executing webhook requests.

Messages created by this client may not have a fully accessible channel or guild available. The messages might report a channel of type UNKNOWN, in which case the channel is assumed to be inaccessible and limited to only webhook requests.

Parameters:

api - The JDA instance, used to handle rate-limits

webhookId - The id of the webhook, for interactions this is the application id

webhookToken - The token of the webhook, for interactions this is the interaction token

Returns:

The IncomingWebhookClient instance

Throws:

IllegalArgumentException - If null is provided or the provided webhook id is not a valid snowflake or the token is blank

See Also:

• InteractionHook.from(JDA, String)