@spec create(String.t() | integer(), map()) :: {:ok, map()} | {:error, term()}

Creates a webhook for a channel.

@spec delete(String.t() | integer()) :: :ok | {:error, term()}

Deletes a webhook.

@spec delete_message(String.t() | integer(), String.t(), String.t() | integer()) ::
  :ok | {:error, term()}

Deletes a message previously sent by a webhook.

Uses webhook token authentication (no bot token required).

Examples

:ok = Webhook.delete_message(webhook_id, token, message_id)

@spec edit_message(
  String.t() | integer(),
  String.t(),
  String.t() | integer(),
  map() | keyword()
) :: {:ok, map()} | {:error, term()}

Edits a message previously sent by a webhook.

Accepts a map or keyword list of message fields to update (content, embeds, components, allowed_mentions). Supports file attachments via keyword opts.

Examples

{:ok, edited} = Webhook.edit_message(wh_id, token, msg_id, %{content: "updated"})
{:ok, edited} = Webhook.edit_message(wh_id, token, msg_id, content: "updated")

@spec execute(String.t() | integer(), String.t(), map() | keyword()) ::
  {:ok, map()} | {:error, term()}

Executes a webhook.

Pass wait: true in opts to receive the created message back (required for subsequent get_message/3, edit_message/4, delete_message/3). Without wait: true, Discord returns 204 No Content.

@spec get(String.t() | integer()) :: {:ok, map()} | {:error, term()}

Gets a webhook by ID.

@spec get_message(String.t() | integer(), String.t(), String.t() | integer()) ::
  {:ok, map()} | {:error, term()}

Gets a message previously sent by a webhook.

Uses webhook token authentication (no bot token required).

Examples

{:ok, msg} = Webhook.get_message(webhook_id, token, message_id)

@spec list_channel(String.t() | integer()) :: {:ok, [map()]} | {:error, term()}

Gets webhooks for a channel.

@spec list_guild(String.t() | integer()) :: {:ok, [map()]} | {:error, term()}

Gets webhooks for a guild.

@spec modify(String.t() | integer(), map()) :: {:ok, map()} | {:error, term()}

Modifies a webhook.