class WebhooksAPI

export declare class WebhooksAPI

create

delete

deleteMessage

Constructors

constructor(
rest: REST
)

Constructs a new instance of the WebhooksAPI class

create(
channelId: Snowflake
data: RESTPostAPIChannelWebhookJSONBody
reason?: string
) : Promise<never>

Creates a new webhook

See also: https://discord.com/developers/docs/resources/webhook#create-webhook

delete(
id: Snowflake
options?: { reason?: string; token?: string; }
) : Promise<void>

Deletes a webhook

See also: https://discord.com/developers/docs/resources/webhook#delete-webhook https://discord.com/developers/docs/resources/webhook#delete-webhook-with-token

deleteMessage(
id: Snowflake
token: string
messageId: Snowflake
options?: { thread_id?: string; }
) : Promise<void>

Deletes an associated message from a webhook

See also: https://discord.com/developers/docs/resources/webhook#delete-webhook-message

edit(
id: Snowflake
webhook: RESTPatchAPIWebhookJSONBody
options?: { reason?: string; token?: string; }
) : Promise<APIWebhook>

Edits a webhook

See also: https://discord.com/developers/docs/resources/webhook#modify-webhook https://discord.com/developers/docs/resources/webhook#modify-webhook-with-token

editMessage(
id: Snowflake
token: string
messageId: Snowflake
data: RESTPatchAPIWebhookWithTokenMessageJSONBody & { thread_id?: string; }
) : Promise<APIMessage>

Edits an associated message from a webhook

See also: https://discord.com/developers/docs/resources/webhook#edit-webhook-message

Overload 1

Overload 2

execute(
id: Snowflake
token: string
data: RESTPostAPIWebhookWithTokenJSONBody & RESTPostAPIWebhookWithTokenQuery & { files?: RawFile[]; wait: true; }
) : Promise<RESTPostAPIWebhookWithTokenWaitResult>

Executes a webhook and returns the created message

See also: https://discord.com/developers/docs/resources/webhook#execute-webhook

executeGitHub(
id: Snowflake
token: string
options: unknown
options?: RESTPostAPIWebhookWithTokenGitHubQuery
) : Promise<void>

Executes a github webhook

See also: https://discord.com/developers/docs/resources/webhook#execute-githubcompatible-webhook

executeSlack(
id: Snowflake
token: string
options: unknown
options?: RESTPostAPIWebhookWithTokenSlackQuery
) : Promise<void>

Executes a slack webhook

See also: https://discord.com/developers/docs/resources/webhook#execute-slackcompatible-webhook

get(
id: Snowflake
token?: string
) : Promise<APIWebhook>

Fetches a webhook

See also: https://discord.com/developers/docs/resources/webhook#get-webhook https://discord.com/developers/docs/resources/webhook#get-webhook-with-token

getMessage(
id: Snowflake
token: string
messageId: Snowflake
options?: { thread_id?: string; }
) : Promise<APIMessage>

Fetches an associated message from a webhook

See also: https://discord.com/developers/docs/resources/webhook#get-webhook-message

class WebhooksAPI

Table of contents

Methods

Constructors

constructor(
rest: REST
)

Methods

create(
channelId: Snowflake
data: RESTPostAPIChannelWebhookJSONBody
reason?: string
) : Promise<never>

delete(
id: Snowflake
options?: { reason?: string; token?: string; }
) : Promise<void>

deleteMessage(
id: Snowflake
token: string
messageId: Snowflake
options?: { thread_id?: string; }
) : Promise<void>

edit(
id: Snowflake
webhook: RESTPatchAPIWebhookJSONBody
options?: { reason?: string; token?: string; }
) : Promise<APIWebhook>

editMessage(
id: Snowflake
token: string
messageId: Snowflake
data: RESTPatchAPIWebhookWithTokenMessageJSONBody & { thread_id?: string; }
) : Promise<APIMessage>

execute(
id: Snowflake
token: string
data: RESTPostAPIWebhookWithTokenJSONBody & RESTPostAPIWebhookWithTokenQuery & { files?: RawFile[]; wait: true; }
) : Promise<RESTPostAPIWebhookWithTokenWaitResult>

executeGitHub(
id: Snowflake
token: string
options: unknown
options?: RESTPostAPIWebhookWithTokenGitHubQuery
) : Promise<void>

executeSlack(
id: Snowflake
token: string
options: unknown
options?: RESTPostAPIWebhookWithTokenSlackQuery
) : Promise<void>

get(
id: Snowflake
token?: string
) : Promise<APIWebhook>

getMessage(
id: Snowflake
token: string
messageId: Snowflake
options?: { thread_id?: string; }
) : Promise<APIMessage>

class WebhooksAPI

Table of contents

Methods

Constructors

constructor(rest: REST)

Methods

create(channelId: Snowflakedata: RESTPostAPIChannelWebhookJSONBodyreason?: string) : Promise<never>

delete(id: Snowflakeoptions?: { reason?: string; token?: string; }) : Promise<void>

deleteMessage(id: Snowflaketoken: stringmessageId: Snowflakeoptions?: { thread_id?: string; }) : Promise<void>

edit(id: Snowflakewebhook: RESTPatchAPIWebhookJSONBodyoptions?: { reason?: string; token?: string; }) : Promise<APIWebhook>

editMessage(id: Snowflaketoken: stringmessageId: Snowflakedata: RESTPatchAPIWebhookWithTokenMessageJSONBody & { thread_id?: string; }) : Promise<APIMessage>

execute(id: Snowflaketoken: stringdata: RESTPostAPIWebhookWithTokenJSONBody & RESTPostAPIWebhookWithTokenQuery & { files?: RawFile[]; wait: true; }) : Promise<RESTPostAPIWebhookWithTokenWaitResult>

executeGitHub(id: Snowflaketoken: stringoptions: unknownoptions?: RESTPostAPIWebhookWithTokenGitHubQuery) : Promise<void>

executeSlack(id: Snowflaketoken: stringoptions: unknownoptions?: RESTPostAPIWebhookWithTokenSlackQuery) : Promise<void>

get(id: Snowflaketoken?: string) : Promise<APIWebhook>

getMessage(id: Snowflaketoken: stringmessageId: Snowflakeoptions?: { thread_id?: string; }) : Promise<APIMessage>

constructor(
rest: REST
)

create(
channelId: Snowflake
data: RESTPostAPIChannelWebhookJSONBody
reason?: string
) : Promise<never>

delete(
id: Snowflake
options?: { reason?: string; token?: string; }
) : Promise<void>

deleteMessage(
id: Snowflake
token: string
messageId: Snowflake
options?: { thread_id?: string; }
) : Promise<void>

edit(
id: Snowflake
webhook: RESTPatchAPIWebhookJSONBody
options?: { reason?: string; token?: string; }
) : Promise<APIWebhook>

editMessage(
id: Snowflake
token: string
messageId: Snowflake
data: RESTPatchAPIWebhookWithTokenMessageJSONBody & { thread_id?: string; }
) : Promise<APIMessage>

execute(
id: Snowflake
token: string
data: RESTPostAPIWebhookWithTokenJSONBody & RESTPostAPIWebhookWithTokenQuery & { files?: RawFile[]; wait: true; }
) : Promise<RESTPostAPIWebhookWithTokenWaitResult>

executeGitHub(
id: Snowflake
token: string
options: unknown
options?: RESTPostAPIWebhookWithTokenGitHubQuery
) : Promise<void>

executeSlack(
id: Snowflake
token: string
options: unknown
options?: RESTPostAPIWebhookWithTokenSlackQuery
) : Promise<void>

get(
id: Snowflake
token?: string
) : Promise<APIWebhook>

getMessage(
id: Snowflake
token: string
messageId: Snowflake
options?: { thread_id?: string; }
) : Promise<APIMessage>