Class ChannelWebhook

constructor

• new ChannelWebhook(
      collection: ChannelWebhookCollection,
      id: string,
  ): ChannelWebhook

  Construct Channel Webhook

  Parameters

  • collection: ChannelWebhookCollection

    Collection
  • id: string

    Webhook

  Returns ChannelWebhook

Readonlyid

$exists

• get $exists(): boolean

  Whether this object exists

  Returns boolean

avatar

• get avatar(): undefined | File

  Webhook avatar

  Returns undefined | File

avatarURL

• get avatarURL(): undefined | string

  Webhook avatar URL

  Returns undefined | string

channel

• get channel(): undefined | Channel

  Channel this webhook belongs to

  Returns undefined | Channel

channelId

• get channelId(): string

  Channel ID this webhook belongs to

  Returns string

name

• get name(): string

  Webhook name

  Returns string

token

• get token(): string

  Secret token for sending messages to this webhook

  Returns string

delete

• delete(): Promise<void>

  Delete this webhook TODO: not in production

  Returns Promise<void>

edit

• edit(
      data: {
          avatar?: null | string;
          name?: null | string;
          permissions?: null | number;
          remove?: "Avatar"[];
      },
  ): Promise<void>

  Edit this webhook

  Parameters

  • data: {
        avatar?: null | string;
        name?: null | string;
        permissions?: null | number;
        remove?: "Avatar"[];
    }

    • Optionalavatar?: null | string

      Description

      Avatar ID

    • Optionalname?: null | string

      Description

      Webhook name

    • Optionalpermissions?: null | number

      Format: uint64

      Description

      Webhook permissions

    • Optionalremove?: "Avatar"[]

      Description

      Fields to remove from webhook

      Default

      []
      Copy

  Returns Promise<void>