Class WebhookRouter

The webhook router for the Guilded REST API.

Example

new WebhookRouter(rest);

Hierarchy

BaseRouter
- WebhookRouter

Index

Constructors

constructor

new WebhookRouter(rest: RESTManager): WebhookRouter
Parameters
- rest: RESTManager
  
  The REST API manager the router belongs to.
Returns WebhookRouter
Inherited from BaseRouter.constructor
- Defined in rest/src/routers/BaseRouter.ts:9

Properties

`Readonly` rest

rest: RESTManager

The REST API manager the router belongs to.

Methods

create

create(serverId: string, channelId: string, name: string): Promise<APIWebhook>
Create a webhook on Guilded.

Returns
The created webhook.

Example
```
webhooks.create('abc', 'abc', 'Webhook');
```
Parameters
- serverId: string
  
  The ID of the server the webhook belongs to.
- channelId: string
  
  The ID of the channel the webhook belongs to.
- name: string
  
  The name of the webhook.
Returns Promise<APIWebhook>
- Defined in rest/src/routers/WebhookRouter.ts:79

delete

delete(serverId: string, webhookId: string): Promise<void>
Delete a webhook from Guilded.

Example
```
webhooks.delete('abc', 'abc');
```
Parameters
- serverId: string
  
  The ID of the server the webhook belongs to.
- webhookId: string
  
  The ID of the webhook to delete.
Returns Promise<void>
- Defined in rest/src/routers/WebhookRouter.ts:110

edit

edit(serverId: string, webhookId: string, name: string, channelId?: string): Promise<APIWebhook>
Edit a webhook on Guilded.

Returns
The edited webhook.

Example
```
webhooks.edit('abc', 'abc', 'Webhook');
```
Parameters
- serverId: string
  
  The ID of the server the webhook belongs to.
- webhookId: string
  
  The ID of the webhook to edit.
- name: string
  
  The name of the webhook.
- Optional channelId: string
  
  The ID of the channel the webhook belongs to.
Returns Promise<APIWebhook>
- Defined in rest/src/routers/WebhookRouter.ts:96

fetchMany

fetchMany(serverId: string, channelId: string): Promise<APIWebhook[]>
Fetch webhooks from Guilded.

Returns
The fetched webhooks.

Example
```
webhooks.fetchMany('abc', 'abc');
```
Parameters
- serverId: string
  
  The ID of the server the webhooks belong to.
- channelId: string
  
  The ID of the channel to fetch webhooks from.
Returns Promise<APIWebhook[]>
- Defined in rest/src/routers/WebhookRouter.ts:38

fetchSingle

fetchSingle(serverId: string, webhookId: string): Promise<APIWebhook>
Fetch a webhook from Guilded.

Returns
The fetched webhook.

Example
```
webhooks.fetchSingle('abc', 'abc');
```
Parameters
- serverId: string
  
  The ID of the server the webhook belongs to.
- webhookId: string
  
  The ID of the webhook to fetch.
Returns Promise<APIWebhook>
- Defined in rest/src/routers/WebhookRouter.ts:24

send

send(webhookId: string, webhookToken: string, payload: APIWebhookMessagePayloadResolvable): Promise<void>
Create a webhook message on Guilded.

Example
```
webhooks.send('abc', 'abc', 'Hello world!');
```
Parameters
- webhookId: string
  
  The ID of the webhook.
- webhookToken: string
  
  The token of the webhook.
- payload: APIWebhookMessagePayloadResolvable
  
  The payload of the message.
Returns Promise<void>
- Defined in rest/src/routers/WebhookRouter.ts:53

Class WebhookRouter

Example

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

rest: RESTManager

Returns WebhookRouter

Properties

Readonly rest

Methods

create

Returns

Example

Parameters

serverId: string

channelId: string

name: string

Returns Promise<APIWebhook>

delete

Example

Parameters

serverId: string

webhookId: string

Returns Promise<void>

edit

Returns

Example

Parameters

serverId: string

webhookId: string

name: string

Optional channelId: string

Returns Promise<APIWebhook>

fetchMany

Returns

Example

Parameters

serverId: string

channelId: string

Returns Promise<APIWebhook[]>

fetchSingle

Returns

Example

Parameters

serverId: string

webhookId: string

Returns Promise<APIWebhook>

send

Example

Parameters

webhookId: string

webhookToken: string

payload: APIWebhookMessagePayloadResolvable

Returns Promise<void>

Settings

Member Visibility

Theme

`Readonly` rest

`Optional` channelId: string