class WebhooksAPI

export declare class WebhooksAPI

Constructors

constructor(
rest: REST
)

Constructs a new instance of the WebhooksAPI class

create(
channelId: Snowflake
body: RESTPostAPIChannelWebhookJSONBody
options?: Pick<RequestData, 'reason' | 'signal'>
) : Promise<never>

Creates a new webhook

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

delete(
id: Snowflake
options?: Pick<RequestData, 'reason' | 'signal'> & { token?: string | undefined; }
) : Promise<void>

Deletes a webhook

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

deleteMessage(
id: Snowflake
token: string
messageId: Snowflake
query?: { thread_id?: string; }
options?: Pick<RequestData, 'signal'>
) : Promise<void>

Deletes an associated message from a webhook

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

edit(
id: Snowflake
body: RESTPatchAPIWebhookJSONBody
options?: Pick<RequestData, 'reason' | 'signal'> & { token?: string | undefined; }
) : Promise<APIWebhook>

Edits a webhook

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

editMessage(
id: Snowflake
token: string
messageId: Snowflake
body: RESTPatchAPIWebhookWithTokenMessageJSONBody & { thread_id?: string; }
options?: Pick<RequestData, 'signal'>
) : Promise<APIMessage>

Edits an associated message from a webhook

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

execute(
id: Snowflake
token: string
body: RESTPostAPIWebhookWithTokenJSONBody & RESTPostAPIWebhookWithTokenQuery & { files?: RawFile[]; wait: true; }
options: Pick<RequestData, 'signal'>
) : 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
query: unknown
query?: RESTPostAPIWebhookWithTokenGitHubQuery
{ signal }?: Pick<RequestData, 'signal'>
) : Promise<void>

Executes a github webhook

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

executeSlack(
id: Snowflake
token: string
query: unknown
query?: RESTPostAPIWebhookWithTokenSlackQuery
{ signal }?: Pick<RequestData, 'signal'>
) : Promise<void>

Executes a slack webhook

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

get(
id: Snowflake
token?: string
options?: Pick<RequestData, 'signal'>
) : Promise<APIWebhook>

Fetches a webhook

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

getMessage(
id: Snowflake
token: string
messageId: Snowflake
query?: RESTGetAPIWebhookWithTokenMessageQuery
options?: Pick<RequestData, 'signal'>
) : Promise<APIMessage>

Fetches an associated message from a webhook

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