discord.js | WebhooksAPI

/

/

/

/

/

WebhooksAPI%3AClass

Search...

K

WebhooksAPI

export declare class WebhooksAPI

export declare class WebhooksAPI

No summary provided.

constructor(rest)

Constructs a new instance of the WebhooksAPI class

Name	Type	Optional	Description
rest	REST	No	None

create(channelId, data, reason?):Promise<never>

Creates a new webhook

See Also

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

Name	Type	Optional	Description
channelId	Snowflake	No	The id of the channel to create the webhook in
data	RESTPostAPIChannelWebhookJSONBody	No	The data to use when creating the webhook
reason	string	Yes	The reason for creating the webhook

delete(id, options?):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

Name	Type	Optional	Description
id	Snowflake	No	The id of the webhook to delete
options	{ reason?: string; token?: string; }	Yes	The options to use when deleting the webhook

deleteMessage(id, token, messageId, options?):Promise<void>

Deletes an associated message from a webhook

See Also

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

Name	Type	Optional	Description
id	Snowflake	No	The id of the webhook
token	string	No	The token of the webhook
messageId	Snowflake	No	The id of the message to delete
options	{ thread_id?: string; }	Yes	The options to use when deleting the message

edit(id, webhook, options?):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

Name	Type	Optional	Description
id	Snowflake	No	The id of the webhook to edit
webhook	RESTPatchAPIWebhookJSONBody	No	The new webhook data
options	{ reason?: string; token?: string; }	Yes	The options to use when editing the webhook

editMessage(id, token, messageId, data):Promise<APIMessage>

Edits an associated message from a webhook

See Also

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

Name	Type	Optional	Description
id	Snowflake	No	The id of the webhook
token	string	No	The token of the webhook
messageId	Snowflake	No	The id of the message to edit
data	RESTPatchAPIWebhookWithTokenMessageJSONBody & { thread_id?: string; }	No	The data to use when editing the message

execute(id, token, data):Promise<RESTPostAPIWebhookWithTokenWaitResult>

Executes a webhook and returns the created message

See Also

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

Name	Type	Optional	Description
id	Snowflake	No	The id of the webhook
token	string	No	The token of the webhook
data	RESTPostAPIWebhookWithTokenJSONBody & RESTPostAPIWebhookWithTokenQuery & { files?: RawFile[]; wait: true; }	No	The data to use when executing the webhook

executeGitHub(id, token, options, options?):Promise<void>

Executes a github webhook

See Also

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

Name	Type	Optional	Description
id	Snowflake	No	The id of the webhook
token	string	No	The token of the webhook
options	unknown	No	The options to use when executing the webhook
options	RESTPostAPIWebhookWithTokenGitHubQuery	Yes	The options to use when executing the webhook

executeSlack(id, token, options, options?):Promise<void>

Executes a slack webhook

See Also

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

Name	Type	Optional	Description
id	Snowflake	No	The id of the webhook
token	string	No	The token of the webhook
options	unknown	No	The options to use when executing the webhook
options	RESTPostAPIWebhookWithTokenSlackQuery	Yes	The options to use when executing the webhook

get(id, token?):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

Name	Type	Optional	Description
id	Snowflake	No	The id of the webhook
token	string	Yes	The token of the webhook

getMessage(id, token, messageId, options?):Promise<APIMessage>

Fetches an associated message from a webhook

See Also

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

Name	Type	Optional	Description
id	Snowflake	No	The id of the webhook
token	string	No	The token of the webhook
messageId	Snowflake	No	The id of the message to fetch
options	{ thread_id?: string; }	Yes	The options to use when fetching the message