hoshii / Exports / Webhook

Webhook

Represents a webhook

Hierarchy

• Base<string>

  ↳ Webhook

Table of contents

Constructors

• constructor

Properties

• channelID
• client
• createdAt
• createdBy
• deletedAt
• id
• name
• serverID
• token

Methods

• delete
• edit
• toJSON
• update

Constructors

constructor

• new Webhook(data, client)

Create a new Webhook

Parameters

Name	Type	Description
data	RawWebhook	The data of the webhook
client	Client	The client

Overrides

Base.constructor

Defined in

lib/structures/Webhook.ts:78

Properties

channelID

• channelID: string

The ID of the channel the webhook is in

Defined in

lib/structures/Webhook.ts:41

---

client

• client: Client

The bot client

Inherited from

Base.client

Defined in

lib/structures/Base.ts:13

---

createdAt

• createdAt: Date

The date the webhook was created at

Defined in

lib/structures/Webhook.ts:46

---

createdBy

• createdBy: string

The ID of the user that created the webhook

Defined in

lib/structures/Webhook.ts:51

---

deletedAt

• deletedAt: Date

The date the webhook was deleted

Defined in

lib/structures/Webhook.ts:56

---

id

• id: string

The ID of the item

Inherited from

Base.id

Defined in

lib/structures/Base.ts:16

---

name

• name: string

The name of the webhook

Defined in

lib/structures/Webhook.ts:61

---

serverID

• serverID: string

The ID of the server the webhook is in

Defined in

lib/structures/Webhook.ts:66

---

token

• token: string

The token of the webhook

Defined in

lib/structures/Webhook.ts:71

Methods

delete

▸ delete(): Promise<void>

Delete the webhook

Returns

Promise<void>

Defined in

lib/structures/Webhook.ts:96

---

edit

▸ edit(options): Promise<Webhook>

Edit the webhook

Parameters

Name	Type	Description
options	WebhookEditOptions	The options to edit the webhook with

Returns

Promise<Webhook>

Defined in

lib/structures/Webhook.ts:105

---

toJSON

▸ toJSON(): WebhookData

Returns the JSON representation of the item

Returns

WebhookData

Overrides

Base.toJSON

Defined in

lib/structures/Webhook.ts:109

---

update

▸ Protected update(data): void

Parameters

Name	Type
data	RawWebhook

Returns

void

Overrides

Base.update

Defined in

lib/structures/Webhook.ts:122