Class Webhook

constructor

• new Webhook(
      data: {
          avatar?: string;
          channelId: string;
          createdAt: string;
          createdBy: string;
          deletedAt?: string;
          id: string;
          name: string;
          serverId: string;
          token?: string;
      },
      client: Client,
  ): Webhook

  Parameters

  • data: {
        avatar?: string;
        channelId: string;
        createdAt: string;
        createdBy: string;
        deletedAt?: string;
        id: string;
        name: string;
        serverId: string;
        token?: string;
    }

    raw data.

    • Optionalavatar?: string

      Avatar Format: media-uri

      Description

      The avatar image associated with the webhook

    • channelId: string

      Channel ID Format: uuid

      Description

      The ID of the channel

    • createdAt: string

      Created at Format: date-time

      Description

      The ISO 8601 timestamp that the webhook was created at

    • createdBy: string

      Created by

      Description

      The ID of the user who created this webhook

    • OptionaldeletedAt?: string

      Deleted at Format: date-time

      Description

      The ISO 8601 timestamp that the webhook was deleted at

    • id: string

      Webhook ID Format: uuid

      Description

      The ID of the webhook

    • name: string

      Name

      Description

      The name of the webhook

    • serverId: string

      Server ID

      Description

      The ID of the server

    • Optionaltoken?: string

      Token

      Description

      The token of the webhook

  • client: Client

    client.

  Returns Webhook

channelID

createdAt

deletedAt

guildID

ownerID

token

username

delete

• delete(): Promise<void>

  Delete the webhook.

  Returns Promise<void>

edit

• edit(options: WebhookEditOptions): Promise<Webhook>

  Update the webhook.

  Parameters

  • options: WebhookEditOptions

    Edit Options.

  Returns Promise<Webhook>

execute

• execute(options: WebhookExecuteOptions): Promise<WebhookMessageDetails>

  Execute this Webhook.

  Parameters

  • options: WebhookExecuteOptions

    Execute Options.

  Returns Promise<WebhookMessageDetails>

requestToken

• requestToken(): Promise<string>

  Request Webhook Token if not provided.

  Returns Promise<string>

  Note

  This method sets this Webhook's token property as well as returning its token.

toJSON

• toJSON(): JSONWebhook

  Returns JSONWebhook