Class Webhook

Represents a webhook on Guilded.

Example

new Webhook(channel, rawWebhook);

Hierarchy

Constructors

constructor

Properties

channel channelId client createdAt createdBy deletedAt? id name raw serverId token?

Accessors

author authorId createdTimestamp deletedTimestamp isCached server

Methods

delete edit fetch fetchAuthor fetchServer send

Constructors

constructor

  • Parameters

    • channel: Channel

      The channel the webhook belongs to.

    • raw: APIWebhook

      The raw data of the webhook.

    • Optional cache: boolean

      Whether to cache the webhook.

    Returns Webhook

Properties

Readonly channel

channel: Channel

Readonly channelId

channelId: string

The ID of the channel the webhook belongs to.

Readonly client

client: Client

Readonly createdAt

createdAt: Date

The date the webhook was created.

Readonly createdBy

createdBy: string

The ID of the user that created the webhook.

Optional Readonly deletedAt

deletedAt?: Date

The date the webhook was deleted.

Readonly id

id: string

Readonly name

name: string

The name of the webhook.

Readonly raw

raw: APIWebhook

Readonly serverId

serverId: string

The ID of the server the webhook belongs to.

Optional Readonly token

token?: string

The token of the webhook.

Accessors

author

  • get author(): undefined | ServerMember

  • The server member that created the webhook.

    Returns undefined | ServerMember

authorId

  • get authorId(): string

  • The ID of the user that created the webhook.

    Returns string

createdTimestamp

  • get createdTimestamp(): number

  • The timestamp the webhook was created.

    Returns number

deletedTimestamp

  • get deletedTimestamp(): undefined | number

  • The timestamp the webhook was deleted.

    Returns undefined | number

isCached

  • get isCached(): boolean

  • Whether the webhook is cached.

    Returns boolean

server

  • get server(): undefined | Server

  • The server the webhook belongs to.

    Returns undefined | Server

Methods

delete

  • Delete the webhook.

    Returns

    The deleted webhook.

    Example

    webhook.delete();

    Returns Promise<Webhook>

edit

  • Edit the webhook.

    Returns

    The edited webhook.

    Example

    webhook.edit('New name');

    Parameters

    • name: string

      The name of the webhook.

    • Optional channelId: string

      The ID of the channel the webhook belongs to.

    Returns Promise<Webhook>

fetch

  • Fetch the webhook.

    Returns

    The fetched webhook.

    Example

    webhook.fetch();

    Parameters

    • Optional options: FetchOptions

      The options to fetch the webhook with.

    Returns Promise<Webhook>

fetchAuthor

  • Fetch the server member that created the webhook.

    Returns

    The fetched server member.

    Example

    webhook.fetchAuthor();

    Parameters

    • Optional options: FetchOptions

      The options to fetch the server member with.

    Returns Promise<ServerMember>

fetchServer

  • Fetch the server the webhook belongs to.

    Returns

    The fetched server.

    Example

    webhook.fetchServer();

    Parameters

    • Optional options: FetchOptions

      The options to fetch the server with.

    Returns Promise<Server>

send

Settings

Member Visibility

Theme