class WebhooksAPI

declare class WebhooksAPI

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

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

Deletes a webhook

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

Deletes an associated message from a webhook

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

Edits a webhook

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

Edits an associated message from a webhook

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

Executes a webhook and returns the created message

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

Executes a github webhook

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

Executes a slack webhook

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

Fetches a webhook

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

Fetches an associated message from a webhook