Nostrum.Api.execute_webhook
You're seeing just the function
execute_webhook
, go back to Nostrum.Api module for more information.
Specs
execute_webhook( Nostrum.Struct.Webhook.id(), Nostrum.Struct.Webhook.token(), %{ content: String.t(), username: String.t(), avatar_url: String.t(), tts: boolean(), file: String.t(), embeds: [Nostrum.Struct.Embed.t()] }, boolean() ) :: error() | {:ok}
Executes a webhook.
Parameters
webhook_id
- Id of the webhook to execute.webhook_token
- Token of the webhook to execute.args
- Map with the following required keys:content
- Message content.file
- File to send.embeds
- List of embeds to send.username
- Overrides the default name of the webhook.avatar_url
- Overrides the default avatar of the webhook.tts
- Whether the message should be read over text to speech.
wait
- Whether to return an error or not. Defaults tofalse
.
Only one of content
, file
or embeds
should be supplied in the args
parameter.