Class Webhook

Represents a webhook on Guilded.

Example

new Webhook(channel, rawWebhook);

Hierarchy

Base
- Webhook

Index

Constructors

constructor

new Webhook(channel: Channel, raw: APIWebhook, cache?: boolean): Webhook
Parameters
- channel: Channel
  
  The channel the webhook belongs to.
- raw: APIWebhook
  
  The raw data of the webhook.
- cache: boolean = ...
  
  Whether to cache the webhook.
Returns Webhook
Overrides Base.constructor
- Defined in guilded.ts/src/structures/Webhook.ts:32

Properties

`Readonly` channel

channel: Channel

The channel the webhook belongs to.

`Readonly` channelId

channelId: string

The ID of the channel the webhook belongs to.

`Readonly` client

client: Client

The client the data model belongs to.

`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

The ID of the structure.

`Readonly` name

name: string

The name of the webhook.

`Readonly` raw

raw: APIWebhook

The raw data of the webhook.

`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
- Defined in guilded.ts/src/structures/Webhook.ts:64

authorId

get authorId(): string
The ID of the user that created the webhook.

Returns string
- Defined in guilded.ts/src/structures/Webhook.ts:69

createdTimestamp

get createdTimestamp(): number
The timestamp the webhook was created.

Returns number
- Defined in guilded.ts/src/structures/Webhook.ts:59

deletedTimestamp

get deletedTimestamp(): undefined | number
The timestamp the webhook was deleted.

Returns undefined | number
- Defined in guilded.ts/src/structures/Webhook.ts:74

isCached

get isCached(): boolean
Whether the webhook is cached.

Returns boolean
- Defined in guilded.ts/src/structures/Webhook.ts:49

server

get server(): undefined | Server
The server the webhook belongs to.

Returns undefined | Server
- Defined in guilded.ts/src/structures/Webhook.ts:54

Methods

delete

delete(): Promise<Webhook>
Delete the webhook.

Returns
The deleted webhook.

Example
```
webhook.delete();
```
Returns Promise<Webhook>
- Defined in guilded.ts/src/structures/Webhook.ts:134

edit

edit(name: string, channelId?: string): Promise<Webhook>
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>
- Defined in guilded.ts/src/structures/Webhook.ts:125

fetch

fetch(options?: FetchOptions): Promise<Webhook>
Fetch the webhook.

Returns
The fetched webhook.

Example
```
webhook.fetch();
```
Parameters
- Optional options: FetchOptions
  
  The options to fetch the webhook with.
Returns Promise<Webhook>
- Defined in guilded.ts/src/structures/Webhook.ts:84

fetchAuthor

fetchAuthor(options?: FetchOptions): Promise<ServerMember>
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>
- Defined in guilded.ts/src/structures/Webhook.ts:104

fetchServer

fetchServer(options?: FetchOptions): Promise<Server>
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>
- Defined in guilded.ts/src/structures/Webhook.ts:94

send

send(payload: WebhookMessagePayloadResolvable): Promise<void>
Send a message with the webhook.

Example
```
webhook.send('Hello world!');
```
Parameters
- payload: WebhookMessagePayloadResolvable
  
  The payload of the message.
Returns Promise<void>
- Defined in guilded.ts/src/structures/Webhook.ts:114

Class Webhook

Example

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

channel: Channel

raw: APIWebhook

cache: boolean = ...

Returns Webhook

Properties

Readonly channel

Readonly channelId

Readonly client

Readonly createdAt

Readonly createdBy

Optional Readonly deletedAt

Readonly id

Readonly name

Readonly raw

Readonly serverId

Optional Readonly token

Accessors

author

Returns undefined | ServerMember

authorId

Returns string

createdTimestamp

Returns number

deletedTimestamp

Returns undefined | number

isCached

Returns boolean

server

Returns undefined | Server

Methods

delete

Returns

Example

Returns Promise<Webhook>

edit

Returns

Example

Parameters

name: string

Optional channelId: string

Returns Promise<Webhook>

fetch

Returns

Example

Parameters

Optional options: FetchOptions

Returns Promise<Webhook>

fetchAuthor

Returns

Example

Parameters

Optional options: FetchOptions

Returns Promise<ServerMember>

fetchServer

Returns

Example

Parameters

Optional options: FetchOptions

Returns Promise<Server>

send

Example

Parameters

payload: WebhookMessagePayloadResolvable

Returns Promise<void>

Settings

Member Visibility

Theme

`Readonly` channel

`Readonly` channelId

`Readonly` client

`Readonly` createdAt

`Readonly` createdBy

`Optional` `Readonly` deletedAt

`Readonly` id

`Readonly` name

`Readonly` raw

`Readonly` serverId

`Optional` `Readonly` token

`Optional` channelId: string

`Optional` options: FetchOptions

`Optional` options: FetchOptions

`Optional` options: FetchOptions