discohook

Appearance

discohook.webhook ​

Classes ​

PartialWebhook ​

discohook.webhook.PartialWebhook

Represents a Discord webhook with no authentication.

Attributes ​

  • id (str): Discord webhook id.
  • token (str): Discord webhook token.
  • type (int): Discord webhook type.
  • guild_id (str): Discord webhook guild id.
  • channel_id (str): Discord webhook channel id.
  • name (str): Discord webhook name.
  • avatar (str): Discord webhook avatar hash.
  • application_id (str): ID of the application that created it.
  • source_guild (str): Guild of the channel that this webhook is following (returned for Channel Follower Webhooks).
  • source_channel (str): Channel that this webhook is following (returned for Channel Follower Webhooks).

Method Index ​

Methods ​

delete ​

python
async delete(self)

Deletes the webhook.

delete_message ​

python
async delete_message(self, message_id: str) -> aiohttp.client_reqrep.ClientResponse

Deletes a message from the webhook.

Arguments ​

  • message_id (str): Message id to delete.

Returns ​

  • Type: aiohttp.ClientResponse
    • Response from the webhook.

edit_message ​

python
async edit_message(self, message_id: str, *components: str | discohook.components.TextDisplay | discohook.components.ActionRow | discohook.components.Section | discohook.components.Container | discohook.components.Separator | discohook.file.File | discohook.components.MediaGallery, thread_id: str | None = None) -> discohook.message.Message

Edits a message from the webhook.

Arguments ​

  • message_id (str): Message id to edit.
  • components (Tuple[TopLevelComponent]): Components to be sent with the message.
  • thread_id (str | None): ID of the thread the message is in.

Returns ​

  • Type: aiohttp.ClientResponse
    • Response from the webhook.

execute ​

python
async execute(self, *components: str | discohook.components.TextDisplay | discohook.components.ActionRow | discohook.components.Section | discohook.components.Container | discohook.components.Separator | discohook.file.File | discohook.components.MediaGallery, poll: discohook.poll.Poll | None = None, username: str | None = None, avatar_url: str | None = None, thread_name: str | None = None, wait: bool = False, thread_id: str | None = None) -> aiohttp.client_reqrep.ClientResponse

Executes the webhook.

Arguments ​

  • components (Tuple[TopLevelComponent]): Components to be sent with the message.
  • poll (Poll | None): Poll to be sent with the message.
  • username (str | None): Name of the webhook. (Overrides the default username)
  • avatar_url (str | None): Avatar of the webhook. (Overrides the default avatar)
  • thread_name (str | None): Name of the thread to create. (Requires the webhook channel to be a forum or media channel)
  • wait (bool): Whether to wait for server confirmation of the message before responding.
  • thread_id (str): Whether to send to a specified thread within the webhook's channel.

Returns ​

  • Type: aiohttp.ClientResponse
    • Response from the webhook.

Raises ​

  • ValueError: If the webhook token is not set or resolved.

fetch_message ​

python
async fetch_message(self, message_id: str, *, thread_id: str | None = None)

Fetches a message sent by the webhook.

Arguments ​

  • message_id (str): Message id to fetch.
  • thread_id (str | None): ID of the thread the message is in.

Returns ​

  • Type: aiohttp.ClientResponse
    • Response from the webhook.

Raises ​

  • ValueError: If the webhook token is not set or resolved.

from_data ​

Creates a webhook from a Discord webhook data.

Arguments ​

  • data (dict): Discord webhook data.

Returns ​

  • Type: PartialWebhook
    • Webhook object.

from_url ​

Creates a webhook from a Discord webhook URL.

Arguments ​

  • url (str): Discord webhook URL.

Returns ​

  • Type: PartialWebhook
    • Webhook object.

modify ​

python
async modify(self, *, name: str | None = None, image_base64: str | None = None, channel_id: str | None = None)

Edits the webhook.

Arguments ​

  • name (str | None): Name of the webhook.
  • image_base64 (str | None): Avatar of the webhook as a base64 encoded string.
  • channel_id (str | None): Channel id of the webhook.

resolve ​

python
async resolve(self)

Populates the webhook attributes.

Webhook ​

discohook.webhook.Webhook

Represents a Discord webhook.

Inheritance ​

  • discohook.webhook.PartialWebhook

Method Index ​

Methods ​

delete ​

python
async delete(self, *, reason: str | None = None)

Deletes the webhook.

Arguments ​

  • reason (str | None): Reason to delete the webhook. Shows up in audit log.

modify ​

python
async modify(self, name: str | None = None, image_base64: str | None = None, channel_id: str | None = None, reason: str | None = None)

Edits the webhook.

Arguments ​

  • name (str | None): Name of the webhook.
  • image_base64 (str | None): Avatar of the webhook as a base64 encoded string.
  • channel_id (str | None): Channel id of the webhook.
  • reason (str | None): Reason to edit the webhook. Shows up in audit log.

Returns ​

  • Type: Webhook
    • Modified webhook object.

resolve ​

python
async resolve(self)

Populates the webhook attributes.