`hikari.webhooks`#

Application and entities that are used to describe webhooks on Discord.

ApplicationWebhook #

Bases: PartialWebhook

Represents an application webhook object on Discord.

This is from the interactions flow.

application_id `class-attribute` `instance-attribute` #

application_id: Snowflake = attrs.field()

The ID of the application that created this webhook.

ChannelFollowerWebhook #

Bases: PartialWebhook

Represents a channel follower webhook object on Discord.

author `class-attribute` `instance-attribute` #

author: User | None = attrs.field(
    eq=False, hash=False, repr=True
)

The user that created the webhook.

Note

This will be None when received within an audit log.

channel_id `class-attribute` `instance-attribute` #

channel_id: Snowflake = attrs.field(
    eq=False, hash=False, repr=True
)

The channel ID this webhook is for.

guild_id `class-attribute` `instance-attribute` #

guild_id: Snowflake = attrs.field(
    eq=False, hash=False, repr=True
)

The guild ID of the webhook.

source_channel `class-attribute` `instance-attribute` #

source_channel: PartialChannel | None = attrs.field(
    eq=False, hash=False, repr=True
)

The partial object of the channel this webhook is following.

This will be None when the user that followed the channel is no longer in the source guild or has lost access to the source channel.

source_guild `class-attribute` `instance-attribute` #

source_guild: PartialGuild | None = attrs.field(
    eq=False, hash=False, repr=True
)

The partial object of the guild this webhook is following.

This will be None when the user that followed the channel is no longer in the source guild or has lost access to the source channel.

delete `async` #

delete() -> None

Delete this webhook.

RAISES	DESCRIPTION
`NotFoundError`	If this webhook is not found.
`ForbiddenError`	If you either lack the `hikari.permissions.Permissions.MANAGE_WEBHOOKS` permission or are not a member of the guild this webhook belongs to.

edit `async` #

edit(
    *,
    name: UndefinedOr[str] = UNDEFINED,
    avatar: UndefinedNoneOr[
        Resource[AsyncReader]
    ] = UNDEFINED,
    channel: UndefinedOr[
        SnowflakeishOr[WebhookChannelT]
    ] = UNDEFINED,
    reason: UndefinedOr[str] = UNDEFINED,
) -> ChannelFollowerWebhook

Edit this webhook.

PARAMETER	DESCRIPTION
`name`	If provided, the new name string. TYPE: `UndefinedOr[str]` DEFAULT: `UNDEFINED`
`avatar`	If provided, the new avatar image. If `None`, then it is removed. If not specified, nothing is changed. TYPE: `UndefinedNoneOr[Resource[AsyncReader]]` DEFAULT: `UNDEFINED`
`channel`	If provided, the object or ID of the new channel the given webhook should be moved to. TYPE: `UndefinedOr[SnowflakeishOr[WebhookChannelT]]` DEFAULT: `UNDEFINED`
`reason`	If provided, the audit log reason explaining why the operation was performed. This field will be used when using the webhook's token rather than bot authorization. TYPE: `UndefinedOr[str]` DEFAULT: `UNDEFINED`

RETURNS	DESCRIPTION
`ChannelFollowerWebhook`	The updated webhook object.

RAISES	DESCRIPTION
`BadRequestError`	If any invalid snowflake IDs are passed; a snowflake may be invalid due to it being outside of the range of a 64 bit integer.
`NotFoundError`	If either the webhook or the channel are not found.
`ForbiddenError`	If you either lack the `hikari.permissions.Permissions.MANAGE_WEBHOOKS` permission or are not a member of the guild this webhook belongs to.
`UnauthorizedError`	If you pass a token that's invalid for the target webhook.
`RateLimitTooLongError`	Raised in the event that a rate limit occurs that is longer than `max_rate_limit` when making a request.
`InternalServerError`	If an internal error occurs on Discord while handling the request.

fetch_channel `async` #

fetch_channel() -> WebhookChannelT

Fetch the channel this webhook is for.

RETURNS	DESCRIPTION
`WebhookChannelT`	The object of the channel this webhook targets.

RAISES	DESCRIPTION
`ForbiddenError`	If you don't have access to the channel this webhook belongs to.
`NotFoundError`	If the channel this message was created in does not exist.
`UnauthorizedError`	If you are unauthorized to make the request (invalid/missing token).
`RateLimitTooLongError`	Raised in the event that a rate limit occurs that is longer than `max_rate_limit` when making a request.
`InternalServerError`	If an internal error occurs on Discord while handling the request.

fetch_self `async` #

fetch_self() -> ChannelFollowerWebhook

Fetch this webhook.

RETURNS	DESCRIPTION
`ChannelFollowerWebhook`	The requested webhook object.

RAISES	DESCRIPTION
`ForbiddenError`	If you're not in the guild that owns this webhook or lack the `hikari.permissions.Permissions.MANAGE_WEBHOOKS` permission.
`NotFoundError`	If the webhook is not found.
`UnauthorizedError`	If you pass a token that's invalid for the target webhook.
`RateLimitTooLongError`	Raised in the event that a rate limit occurs that is longer than `max_rate_limit` when making a request.
`InternalServerError`	If an internal error occurs on Discord while handling the request.

ExecutableWebhook #

Bases: ABC

An abstract class with logic for executing entities as webhooks.

app `abstractmethod` `property` #

app: RESTAware

Client application that models may use for procedures.

token `abstractmethod` `property` #

token: str | None

Webhook's token.

Note

If this is None then the methods provided by hikari.webhooks.ExecutableWebhook will always raise a ValueError.

webhook_id `abstractmethod` `property` #

webhook_id: Snowflake

ID used to execute this entity as a webhook.

delete_message `async` #

delete_message(message: SnowflakeishOr[Message]) -> None

Delete a given message in a given channel.

PARAMETER	DESCRIPTION
`message`	The message to delete. This may be the object or the ID of an existing message. TYPE: `SnowflakeishOr[Message]`

RAISES	DESCRIPTION
`ValueError`	If `token` is not available.
`UnauthorizedError`	If you are unauthorized to make the request (invalid/missing token).
`NotFoundError`	If the webhook or the message are not found.
`RateLimitTooLongError`	Raised in the event that a rate limit occurs that is longer than `max_rate_limit` when making a request.
`InternalServerError`	If an internal error occurs on Discord while handling the request.

edit_message `async` #

edit_message(
    message: SnowflakeishOr[Message],
    content: UndefinedNoneOr[Any] = UNDEFINED,
    *,
    attachment: UndefinedNoneOr[
        Resourceish | Attachment
    ] = UNDEFINED,
    attachments: UndefinedNoneOr[
        Sequence[Resourceish | Attachment]
    ] = UNDEFINED,
    component: UndefinedNoneOr[
        ComponentBuilder
    ] = UNDEFINED,
    components: UndefinedNoneOr[
        Sequence[ComponentBuilder]
    ] = UNDEFINED,
    embed: UndefinedNoneOr[Embed] = UNDEFINED,
    embeds: UndefinedNoneOr[Sequence[Embed]] = UNDEFINED,
    mentions_everyone: UndefinedOr[bool] = UNDEFINED,
    user_mentions: UndefinedOr[
        SnowflakeishSequence[PartialUser] | bool
    ] = UNDEFINED,
    role_mentions: UndefinedOr[
        SnowflakeishSequence[PartialRole] | bool
    ] = UNDEFINED,
) -> Message

Edit a message sent by a webhook.

Note

Mentioning everyone, roles, or users in message edits currently will not send a push notification showing a new mention to people on Discord. It will still highlight in their chat as if they were mentioned, however.

Warning

If you specify a text content, mentions_everyone, mentions_reply, user_mentions, and role_mentions will default to False as the message will be re-parsed for mentions. This will also occur if only one of the four are specified

This is a limitation of Discord's design. If in doubt, specify all four of them each time.

PARAMETER	DESCRIPTION
`message`	The message to delete. This may be the object or the ID of an existing message. TYPE: `SnowflakeishOr[Message]`
`content`	If provided, the message contents. If `hikari.undefined.UNDEFINED`, then nothing will be sent in the content. Any other value here will be cast to a `str`. If this is a `hikari.embeds.Embed` and no `embed` nor `embeds` kwarg is provided, then this will instead update the embed. This allows for simpler syntax when sending an embed alone. Likewise, if this is a `hikari.files.Resource`, then the content is instead treated as an attachment if no `attachment` nor `attachments` kwargs are provided. TYPE: `UndefinedNoneOr[Any]` DEFAULT: `UNDEFINED`
`attachment`	If provided, the attachment to set on the message. If `hikari.undefined.UNDEFINED`, the previous attachment, if present, is not changed. If this is `None`, then the attachment is removed, if present. Otherwise, the new attachment that was provided will be attached. TYPE: `UndefinedNoneOr[Resourceish \| Attachment]` DEFAULT: `UNDEFINED`
`attachments`	If provided, the attachments to set on the message. If `hikari.undefined.UNDEFINED`, the previous attachments, if present, are not changed. If this is `None`, then the attachments is removed, if present. Otherwise, the new attachments that were provided will be attached. TYPE: `UndefinedNoneOr[Sequence[Resourceish \| Attachment]]` DEFAULT: `UNDEFINED`
`component`	If provided, builder object of the component to set for this message. This component will replace any previously set components and passing `None` will remove all components. TYPE: `UndefinedNoneOr[ComponentBuilder]` DEFAULT: `UNDEFINED`
`components`	If provided, a sequence of the component builder objects set for this message. These components will replace any previously set components and passing `None` or an empty sequence will remove all components. TYPE: `UndefinedNoneOr[Sequence[ComponentBuilder]]` DEFAULT: `UNDEFINED`
`embed`	If provided, the embed to set on the message. If `hikari.undefined.UNDEFINED`, the previous embed(s) are not changed. If this is `None` then any present embeds are removed. Otherwise, the new embed that was provided will be used as the replacement. TYPE: `UndefinedNoneOr[Embed]` DEFAULT: `UNDEFINED`
`embeds`	If provided, the embeds to set on the message. If `hikari.undefined.UNDEFINED`, the previous embed(s) are not changed. If this is `None` then any present embeds are removed. Otherwise, the new embeds that were provided will be used as the replacement. TYPE: `UndefinedNoneOr[Sequence[Embed]]` DEFAULT: `UNDEFINED`
`mentions_everyone`	If provided, sanitation for `@everyone` mentions. If `hikari.undefined.UNDEFINED`, then the previous setting is not changed. If `True`, then `@everyone`/`@here` mentions in the message content will show up as mentioning everyone that can view the chat. TYPE: `UndefinedOr[bool]` DEFAULT: `UNDEFINED`
`user_mentions`	If provided, and `True`, all user mentions will be detected. If provided, and `False`, all user mentions will be ignored if appearing in the message body. Alternatively this may be a collection of `hikari.snowflakes.Snowflake`, or `hikari.users.PartialUser` derivatives to enforce mentioning specific users. TYPE: `UndefinedOr[SnowflakeishSequence[PartialUser] \| bool]` DEFAULT: `UNDEFINED`
`role_mentions`	If provided, and `True`, all role mentions will be detected. If provided, and `False`, all role mentions will be ignored if appearing in the message body. Alternatively this may be a collection of `hikari.snowflakes.Snowflake`, or `hikari.guilds.PartialRole` derivatives to enforce mentioning specific roles. TYPE: `UndefinedOr[SnowflakeishSequence[PartialRole] \| bool]` DEFAULT: `UNDEFINED`

RETURNS	DESCRIPTION
`Message`	The edited message.

RAISES	DESCRIPTION
`ValueError`	If more than 100 unique objects/entities are passed for `role_mentions` or `user_mentions` or `token` is not available.
`TypeError`	If both `attachment` and `attachments` are specified or if both `embed` and `embeds` are specified.
`BadRequestError`	This may be raised in several discrete situations, such as messages being empty with no attachments or embeds; messages with more than 2000 characters in them, embeds that exceed one of the many embed limits; too many attachments; attachments that are too large; too many components.
`UnauthorizedError`	If you are unauthorized to make the request (invalid/missing token).
`NotFoundError`	If the webhook or the message are not found.
`RateLimitTooLongError`	Raised in the event that a rate limit occurs that is longer than `max_rate_limit` when making a request.
`InternalServerError`	If an internal error occurs on Discord while handling the request.

execute `async` #

execute(
    content: UndefinedOr[Any] = UNDEFINED,
    *,
    username: UndefinedOr[str] = UNDEFINED,
    avatar_url: UndefinedType | str | URL = UNDEFINED,
    tts: UndefinedOr[bool] = UNDEFINED,
    attachment: UndefinedOr[Resourceish] = UNDEFINED,
    attachments: UndefinedOr[
        Sequence[Resourceish]
    ] = UNDEFINED,
    component: UndefinedOr[ComponentBuilder] = UNDEFINED,
    components: UndefinedOr[
        Sequence[ComponentBuilder]
    ] = UNDEFINED,
    embed: UndefinedOr[Embed] = UNDEFINED,
    embeds: UndefinedOr[Sequence[Embed]] = UNDEFINED,
    poll: UndefinedOr[PollBuilder] = UNDEFINED,
    mentions_everyone: UndefinedOr[bool] = UNDEFINED,
    user_mentions: UndefinedOr[
        SnowflakeishSequence[PartialUser] | bool
    ] = UNDEFINED,
    role_mentions: UndefinedOr[
        SnowflakeishSequence[PartialRole] | bool
    ] = UNDEFINED,
    flags: UndefinedType | int | MessageFlag = UNDEFINED,
) -> Message

Execute the webhook to create a message.

Warning

At the time of writing, username and avatar_url are ignored for interaction webhooks.

Additionally, hikari.messages.MessageFlag.SUPPRESS_EMBEDS, hikari.messages.MessageFlag.SUPPRESS_NOTIFICATIONS and hikari.messages.MessageFlag.EPHEMERAL are the only flags that can be set, with hikari.messages.MessageFlag.EPHEMERAL being limited to interaction webhooks.

PARAMETER	DESCRIPTION
`content`	If provided, the message contents. If `hikari.undefined.UNDEFINED`, then nothing will be sent in the content. Any other value here will be cast to a `str`. If this is a `hikari.embeds.Embed` and no `embed` and no `embeds` kwargs are provided, then this will instead update the embed. This allows for simpler syntax when sending an embed alone. Likewise, if this is a `hikari.files.Resource`, then the content is instead treated as an attachment if no `attachment` and no `attachments` kwargs are provided. TYPE: `UndefinedOr[Any]` DEFAULT: `UNDEFINED`
`username`	If provided, the username to override the webhook's username for this request. TYPE: `UndefinedOr[str]` DEFAULT: `UNDEFINED`
`avatar_url`	If provided, the url of an image to override the webhook's avatar with for this request. TYPE: `UndefinedType \| str \| URL` DEFAULT: `UNDEFINED`
`tts`	If provided, whether the message will be sent as a TTS message. TYPE: `UndefinedOr[bool]` DEFAULT: `UNDEFINED`
`attachment`	If provided, the message attachment. This can be a resource, or string of a path on your computer or a URL. TYPE: `UndefinedOr[Resourceish]` DEFAULT: `UNDEFINED`
`attachments`	If provided, the message attachments. These can be resources, or strings consisting of paths on your computer or URLs. TYPE: `UndefinedOr[Sequence[Resourceish]]` DEFAULT: `UNDEFINED`
`component`	If provided, builder object of the component to include in this message. TYPE: `UndefinedOr[ComponentBuilder]` DEFAULT: `UNDEFINED`
`components`	If provided, a sequence of the component builder objects to include in this message. TYPE: `UndefinedOr[Sequence[ComponentBuilder]]` DEFAULT: `UNDEFINED`
`embed`	If provided, the message embed. TYPE: `UndefinedOr[Embed]` DEFAULT: `UNDEFINED`
`embeds`	If provided, the message embeds. TYPE: `UndefinedOr[Sequence[Embed]]` DEFAULT: `UNDEFINED`
`poll`	If provided, the poll to set on the message. TYPE: `UndefinedOr[PollBuilder]` DEFAULT: `UNDEFINED`
`mentions_everyone`	If provided, whether the message should parse @everyone/@here mentions. TYPE: `UndefinedOr[bool]` DEFAULT: `UNDEFINED`
`user_mentions`	If provided, and `True`, all mentions will be parsed. If provided, and `False`, no mentions will be parsed. Alternatively this may be a collection of `hikari.snowflakes.Snowflake`, or `hikari.users.PartialUser` derivatives to enforce mentioning specific users. TYPE: `UndefinedOr[SnowflakeishSequence[PartialUser] \| bool]` DEFAULT: `UNDEFINED`
`role_mentions`	If provided, and `True`, all mentions will be parsed. If provided, and `False`, no mentions will be parsed. Alternatively this may be a collection of `hikari.snowflakes.Snowflake`, or `hikari.guilds.PartialRole` derivatives to enforce mentioning specific roles. TYPE: `UndefinedOr[SnowflakeishSequence[PartialRole] \| bool]` DEFAULT: `UNDEFINED`
`flags`	The flags to set for this webhook message. TYPE: `UndefinedType \| int \| MessageFlag` DEFAULT: `UNDEFINED`

RETURNS	DESCRIPTION
`Message`	The created message object.

RAISES	DESCRIPTION
`NotFoundError`	If the current webhook is not found.
`BadRequestError`	This can be raised if the file is too large; if the embed exceeds the defined limits; if the message content is specified only and empty or greater than `2000` characters; if neither content, file or embeds are specified. If any invalid snowflake IDs are passed; a snowflake may be invalid due to it being outside of the range of a 64 bit integer.
`UnauthorizedError`	If you pass a token that's invalid for the target webhook.
`ValueError`	If `token` is not available.
`TypeError`	If both `attachment` and `attachments`, `component` and `components` or `embed` and `embeds` are specified.

fetch_message `async` #

fetch_message(message: SnowflakeishOr[Message]) -> Message

Fetch an old message sent by the webhook.

PARAMETER	DESCRIPTION
`message`	The message to fetch. This may be the object or the ID of an existing channel. TYPE: `SnowflakeishOr[Message]`

RETURNS	DESCRIPTION
`Message`	The requested message.

RAISES	DESCRIPTION
`ValueError`	If `token` is not available.
`UnauthorizedError`	If you are unauthorized to make the request (invalid/missing token).
`NotFoundError`	If the webhook is not found or the webhook's message wasn't found.
`RateLimitTooLongError`	Raised in the event that a rate limit occurs that is longer than `max_rate_limit` when making a request.
`InternalServerError`	If an internal error occurs on Discord while handling the request.

IncomingWebhook #

Bases: PartialWebhook, ExecutableWebhook

Represents an incoming webhook object on Discord.

This is an endpoint that can have messages sent to it using standard HTTP requests, which enables external services that are not bots to send informational messages to specific channels.

author `class-attribute` `instance-attribute` #

author: User | None = attrs.field(
    eq=False, hash=False, repr=True
)

The user that created the webhook.

Note

This will be None when fetched with the webhook's token rather than bot authorization or when received within audit logs.

channel_id `class-attribute` `instance-attribute` #

channel_id: Snowflake = attrs.field(
    eq=False, hash=False, repr=True
)

The channel ID this webhook is for.

guild_id `class-attribute` `instance-attribute` #

guild_id: Snowflake = attrs.field(
    eq=False, hash=False, repr=True
)

The guild ID of the webhook.

token `class-attribute` `instance-attribute` #

token: str | None = attrs.field(
    eq=False, hash=False, repr=False
)

The token for the webhook.

Note

This is only available for incoming webhooks that are created in the channel settings.

webhook_id `property` #

webhook_id: Snowflake

ID used to execute this entity as a webhook.

delete `async` #

delete(*, use_token: UndefinedOr[bool] = UNDEFINED) -> None

Delete this webhook.

PARAMETER	DESCRIPTION
`use_token`	If set to `True` then the webhook's token will be used for this request; if set to `False` then bot authorization will be used; if not specified then the webhook's token will be used for the request if it's set else bot authorization. TYPE: `UndefinedOr[bool]` DEFAULT: `UNDEFINED`

RAISES	DESCRIPTION
`NotFoundError`	If this webhook is not found.
`ForbiddenError`	If you either lack the `hikari.permissions.Permissions.MANAGE_WEBHOOKS` permission or are not a member of the guild this webhook belongs to.
`ValueError`	If `use_token` is passed as `True` when `hikari.webhooks.IncomingWebhook.token` is `None`.

edit `async` #

edit(
    *,
    name: UndefinedOr[str] = UNDEFINED,
    avatar: UndefinedNoneOr[
        Resource[AsyncReader]
    ] = UNDEFINED,
    channel: UndefinedOr[
        SnowflakeishOr[WebhookChannelT]
    ] = UNDEFINED,
    reason: UndefinedOr[str] = UNDEFINED,
    use_token: UndefinedOr[bool] = UNDEFINED,
) -> IncomingWebhook

Edit this webhook.

PARAMETER	DESCRIPTION
`name`	If provided, the new name string. TYPE: `UndefinedOr[str]` DEFAULT: `UNDEFINED`
`avatar`	If provided, the new avatar image. If `None`, then it is removed. If not specified, nothing is changed. TYPE: `UndefinedNoneOr[Resource[AsyncReader]]` DEFAULT: `UNDEFINED`
`channel`	If provided, the object or ID of the new channel the given webhook should be moved to. TYPE: `UndefinedOr[SnowflakeishOr[WebhookChannelT]]` DEFAULT: `UNDEFINED`
`reason`	If provided, the audit log reason explaining why the operation was performed. This field will be used when using the webhook's token rather than bot authorization. TYPE: `UndefinedOr[str]` DEFAULT: `UNDEFINED`
`use_token`	If set to `True` then the webhook's token will be used for this request; if set to `False` then bot authorization will be used; if not specified then the webhook's token will be used for the request if it's set else bot authorization. TYPE: `UndefinedOr[bool]` DEFAULT: `UNDEFINED`

RETURNS	DESCRIPTION
`IncomingWebhook`	The updated webhook object.

RAISES	DESCRIPTION
`ValueError`	If `use_token` is passed as `True` when `hikari.webhooks.IncomingWebhook.token` is `None`.
`BadRequestError`	If any invalid snowflake IDs are passed; a snowflake may be invalid due to it being outside the range of a 64-bit integer.
`NotFoundError`	If either the webhook or the channel are not found.
`ForbiddenError`	If you either lack the `hikari.permissions.Permissions.MANAGE_WEBHOOKS` permission or are not a member of the guild this webhook belongs to.
`UnauthorizedError`	If you pass a token that's invalid for the target webhook.
`RateLimitTooLongError`	Raised in the event that a rate limit occurs that is longer than `max_rate_limit` when making a request.
`InternalServerError`	If an internal error occurs on Discord while handling the request.

fetch_channel `async` #

fetch_channel() -> WebhookChannelT

Fetch the channel this webhook is for.

RETURNS	DESCRIPTION
`WebhookChannelT`	The object of the channel this webhook targets.

RAISES	DESCRIPTION
`ForbiddenError`	If you don't have access to the channel this webhook belongs to.
`NotFoundError`	If the channel this message was created in does not exist.
`UnauthorizedError`	If you are unauthorized to make the request (invalid/missing token).
`RateLimitTooLongError`	Raised in the event that a rate limit occurs that is longer than `max_rate_limit` when making a request.
`InternalServerError`	If an internal error occurs on Discord while handling the request.

fetch_self `async` #

fetch_self(
    *, use_token: UndefinedOr[bool] = UNDEFINED
) -> IncomingWebhook

Fetch this webhook.

PARAMETER	DESCRIPTION
`use_token`	If set to `True` then the webhook's token will be used for this request; if set to `False` then bot authorization will be used; if not specified then the webhook's token will be used for the request if it's set else bot authorization. TYPE: `UndefinedOr[bool]` DEFAULT: `UNDEFINED`

RETURNS	DESCRIPTION
`IncomingWebhook`	The requested webhook object.

RAISES	DESCRIPTION
`ValueError`	If `use_token` is passed as `True` when `hikari.webhooks.IncomingWebhook.token` is `None`.
`ForbiddenError`	If you're not in the guild that owns this webhook or lack the `hikari.permissions.Permissions.MANAGE_WEBHOOKS` permission.
`NotFoundError`	If the webhook is not found.
`UnauthorizedError`	If you pass a token that's invalid for the target webhook.
`RateLimitTooLongError`	Raised in the event that a rate limit occurs that is longer than `max_rate_limit` when making a request.
`InternalServerError`	If an internal error occurs on Discord while handling the request.

PartialWebhook #

Bases: Unique

Base class for all webhook implementations.

app `class-attribute` `instance-attribute` #

app: RESTAware = attrs.field(
    repr=False,
    eq=False,
    hash=False,
    metadata={attrs_extensions.SKIP_DEEP_COPY: True},
)

Client application that models may use for procedures.

application_id `class-attribute` `instance-attribute` #

application_id: Snowflake | None = attrs.field(
    eq=False, hash=False, repr=False
)

The ID of the application that created this webhook.

avatar_hash `class-attribute` `instance-attribute` #

avatar_hash: str | None = attrs.field(
    eq=False, hash=False, repr=False
)

The avatar hash of the webhook.

default_avatar_url `property` #

default_avatar_url: URL

Default avatar URL for the user.

id `class-attribute` `instance-attribute` #

id: Snowflake = attrs.field(hash=True, repr=True)

The ID of this entity.

mention `property` #

mention: str

Return a raw mention string for the given webhook's user.

Note

This exists purely for consistency. Webhooks do not receive events from the gateway, and without some bot backend to support it, will not be able to detect mentions of their webhook.

Examples:

>>> some_webhook.mention
'<@123456789123456789>'

name `class-attribute` `instance-attribute` #

name: str = attrs.field(eq=False, hash=False, repr=True)

The name of the webhook.

type `class-attribute` `instance-attribute` #

type: WebhookType | int = attrs.field(
    eq=False, hash=False, repr=True
)

The type of the webhook.

make_avatar_url #

make_avatar_url(
    *,
    file_format: UndefinedOr[
        Literal[
            "PNG", "JPEG", "JPG", "WEBP", "AWEBP", "GIF"
        ]
    ] = UNDEFINED,
    size: int = 4096,
    lossless: bool = True,
) -> URL | None

Generate the avatar URL for this webhook, if set.

If no avatar is set, this returns None.

PARAMETER	DESCRIPTION
`file_format`	The format to use for this URL. Supports `PNG`, `JPEG`, `JPG`, `WEBP`, `AWEBP` and `GIF`. If not specified, the format will be determined based on whether the avatar is animated or not. TYPE: `UndefinedOr[Literal['PNG', 'JPEG', 'JPG', 'WEBP', 'AWEBP', 'GIF']]` DEFAULT: `UNDEFINED`
`size`	The size to set for the URL. Can be any power of two between `16` and `4096`. TYPE: `int` DEFAULT: `4096`
`lossless`	Whether to return a lossless or compressed WEBP image; This is ignored if `file_format` is not `WEBP` or `AWEBP`. TYPE: `bool` DEFAULT: `True`

RETURNS	DESCRIPTION
`Optional[URL]`	The URL, or `None` if no avatar is set.

RAISES	DESCRIPTION
`TypeError`	If an invalid format is passed for `file_format`; If an animated format is requested for a static avatar.
`ValueError`	If `size` is specified but is not a power of two or not between 16 and 4096.

WebhookType #

Bases: int, Enum

Types of webhook.

APPLICATION `class-attribute` `instance-attribute` #

APPLICATION = 3

Application webhook (from the interactions flow).

CHANNEL_FOLLOWER `class-attribute` `instance-attribute` #

CHANNEL_FOLLOWER = 2

Channel Follower webhook.

INCOMING `class-attribute` `instance-attribute` #

INCOMING = 1

Incoming webhook.

hikari.webhooks#

ApplicationWebhook #

application_id class-attribute instance-attribute #

ChannelFollowerWebhook #

author class-attribute instance-attribute #

channel_id class-attribute instance-attribute #

guild_id class-attribute instance-attribute #

source_channel class-attribute instance-attribute #

source_guild class-attribute instance-attribute #

delete async #

edit async #

fetch_channel async #

fetch_self async #

ExecutableWebhook #

app abstractmethod property #

token abstractmethod property #

webhook_id abstractmethod property #

delete_message async #

edit_message async #

execute async #

fetch_message async #

IncomingWebhook #

author class-attribute instance-attribute #

channel_id class-attribute instance-attribute #

guild_id class-attribute instance-attribute #

token class-attribute instance-attribute #

webhook_id property #

delete async #

edit async #

fetch_channel async #

fetch_self async #

PartialWebhook #

app class-attribute instance-attribute #

application_id class-attribute instance-attribute #

avatar_hash class-attribute instance-attribute #

default_avatar_url property #

id class-attribute instance-attribute #

mention property #

name class-attribute instance-attribute #

type class-attribute instance-attribute #

make_avatar_url #

WebhookType #

APPLICATION class-attribute instance-attribute #

CHANNEL_FOLLOWER class-attribute instance-attribute #

INCOMING class-attribute instance-attribute #

`hikari.webhooks`#

application_id `class-attribute` `instance-attribute` #

author `class-attribute` `instance-attribute` #

channel_id `class-attribute` `instance-attribute` #

guild_id `class-attribute` `instance-attribute` #

source_channel `class-attribute` `instance-attribute` #

source_guild `class-attribute` `instance-attribute` #

delete `async` #

edit `async` #

fetch_channel `async` #

fetch_self `async` #

app `abstractmethod` `property` #

token `abstractmethod` `property` #

webhook_id `abstractmethod` `property` #

delete_message `async` #

edit_message `async` #

execute `async` #

fetch_message `async` #

author `class-attribute` `instance-attribute` #

channel_id `class-attribute` `instance-attribute` #

guild_id `class-attribute` `instance-attribute` #

token `class-attribute` `instance-attribute` #

webhook_id `property` #

delete `async` #

edit `async` #

fetch_channel `async` #

fetch_self `async` #

app `class-attribute` `instance-attribute` #

application_id `class-attribute` `instance-attribute` #

avatar_hash `class-attribute` `instance-attribute` #

default_avatar_url `property` #

id `class-attribute` `instance-attribute` #

mention `property` #

name `class-attribute` `instance-attribute` #

type `class-attribute` `instance-attribute` #

APPLICATION `class-attribute` `instance-attribute` #

CHANNEL_FOLLOWER `class-attribute` `instance-attribute` #

INCOMING `class-attribute` `instance-attribute` #