Webhook
HTTP Rest API implementation for the following Resource:
Summary
Functions
Webhook.createWebhookAsync(instance: request.Request, channelId: apiTypes.Snowflake, jsonParams: apiTypes.CreateWebhookRequest, auditLogReason: string?) → future.FutureLike<string, apiTypes.CreateWebhookResponse>Webhook.getChannelWebhooksAsync(instance: request.Request, channelId: apiTypes.Snowflake) → future.FutureLike<string, apiTypes.GetChannelWebhooksResponse>Webhook.getGuildWebhooksAsync(instance: request.Request, guildId: apiTypes.Snowflake) → future.FutureLike<string, apiTypes.GetGuildWebhooksResponse>Webhook.getWebhookAsync(instance: request.Request, webhookId: apiTypes.Snowflake) → future.FutureLike<string, apiTypes.GetWebhookResponse>Webhook.getWebhookWithTokenAsync(instance: request.Request, webhookId: apiTypes.Snowflake, webhookToken: string) → future.FutureLike<string, apiTypes.GetWebhookWithTokenResponse>Webhook.modifyWebhookAsync(instance: request.Request, webhookId: apiTypes.Snowflake, jsonParams: apiTypes.ModifyWebhookRequest, auditLogReason: string?) → future.FutureLike<string, apiTypes.ModifyWebhookResponse>Webhook.modifyWebhookWithTokenAsync(instance: request.Request, webhookId: apiTypes.Snowflake, webhookToken: string, jsonParams: apiTypes.ModifyWebhookRequest, auditLogReason: string?) → future.FutureLike<string, apiTypes.ModifyWebhookWithTokenResponse>Webhook.deleteWebhookAsync(instance: request.Request, webhookId: apiTypes.Snowflake, auditLogReason: string?) → future.FutureLike<string, apiTypes.DeleteWebhookResponse>Webhook.deleteWebhookWithTokenAsync(instance: request.Request, webhookId: apiTypes.Snowflake, webhookToken: string, auditLogReason: string?) → future.FutureLike<string, apiTypes.DeleteWebhookWitHTokenResponse>Webhook.executeWebhookAsync(instance: request.Request, webhookId: apiTypes.Snowflake, webhookToken: string, jsonParams: apiTypes.ExecuteWebhookRequest, urlParams: { wait: boolean?, threadId: apiTypes.Snowflake?, }) → future.FutureLike<string, apiTypes.ExecuteWebhookResponse>Webhook.executeSlackCompatibleWebhookAsync(instance: request.Request, webhookId: apiTypes.Snowflake, webhookToken: string) → future.FutureLike< string, apiTypes.ExecuteSlackCompatibleWebhookResponse >Webhook.executeGithubCompatibleWebhookAsync(instance: request.Request, webhookId: apiTypes.Snowflake, webhookToken: string) → future.FutureLike< string, apiTypes.ExecuteGithubCompatibleWebhookResponse >Webhook.getWebhookMessageAsync(instance: request.Request, webhookId: apiTypes.Snowflake, webhookToken: string, messageId: apiTypes.Snowflake, urlParams: { threadId: apiTypes.Snowflake?, }) → future.FutureLike<string, apiTypes.GetWebhookMessageResponse>Webhook.editWebhookMessageAsync(instance: request.Request, webhookId: apiTypes.Snowflake, webhookToken: string, messageId: apiTypes.Snowflake, jsonParams: apiTypes.EditWebhookMessageRequest, urlParams: { threadId: apiTypes.Snowflake?, }) → future.FutureLike<string, apiTypes.EditWebhookMessageResponse>Webhook.deleteWebhookMessageAsync(instance: request.Request, webhookId: apiTypes.Snowflake, webhookToken: string, messageId: apiTypes.Snowflake, urlParams: { threadId: apiTypes.Snowflake?, }) → future.FutureLike<string, apiTypes.DeleteWebhookMessageResponse>Functions
Section titled “Functions”createWebhookAsync
Section titled “createWebhookAsync”Webhook . createWebhookAsync ( instance , channelId , jsonParams , auditLogReason ) -> FutureLike<string, CreateWebhookResponse>
https://discord.com/developers/docs/resources/webhook#create-webhook
Parameters
| instance: Request | |
| channelId: Snowflake | |
| jsonParams: CreateWebhookRequest | |
| auditLogReason: string? |
Returns
| FutureLike<string, CreateWebhookResponse> |
getChannelWebhooksAsync
Section titled “getChannelWebhooksAsync”Webhook . getChannelWebhooksAsync ( instance , channelId ) -> FutureLike<string, GetChannelWebhooksResponse>
https://discord.com/developers/docs/resources/webhook#get-channel-webhooks
Parameters
| instance: Request | |
| channelId: Snowflake |
Returns
| FutureLike<string, GetChannelWebhooksResponse> |
getGuildWebhooksAsync
Section titled “getGuildWebhooksAsync”Webhook . getGuildWebhooksAsync ( instance , guildId ) -> FutureLike<string, GetGuildWebhooksResponse>
https://discord.com/developers/docs/resources/webhook#get-guild-webhooks
Parameters
| instance: Request | |
| guildId: Snowflake |
Returns
| FutureLike<string, GetGuildWebhooksResponse> |
getWebhookAsync
Section titled “getWebhookAsync”Webhook . getWebhookAsync ( instance , webhookId ) -> FutureLike<string, GetWebhookResponse>
https://discord.com/developers/docs/resources/webhook#get-webhook
Parameters
| instance: Request | |
| webhookId: Snowflake |
Returns
| FutureLike<string, GetWebhookResponse> |
getWebhookWithTokenAsync
Section titled “getWebhookWithTokenAsync”Webhook . getWebhookWithTokenAsync ( instance , webhookId , webhookToken ) -> FutureLike<string, GetWebhookWithTokenResponse>
https://discord.com/developers/docs/resources/webhook#get-webhook-with-token
Parameters
| instance: Request | |
| webhookId: Snowflake | |
| webhookToken: string |
Returns
| FutureLike<string, GetWebhookWithTokenResponse> |
modifyWebhookAsync
Section titled “modifyWebhookAsync”Webhook . modifyWebhookAsync ( instance , webhookId , jsonParams , auditLogReason ) -> FutureLike<string, ModifyWebhookResponse>
https://discord.com/developers/docs/resources/webhook#modify-webhook
Parameters
| instance: Request | |
| webhookId: Snowflake | |
| jsonParams: ModifyWebhookRequest | |
| auditLogReason: string? |
Returns
| FutureLike<string, ModifyWebhookResponse> |
modifyWebhookWithTokenAsync
Section titled “modifyWebhookWithTokenAsync”Webhook . modifyWebhookWithTokenAsync ( instance , webhookId , webhookToken , jsonParams , auditLogReason ) -> FutureLike<string, ModifyWebhookWithTokenResponse>
https://discord.com/developers/docs/resources/webhook#modify-webhook-with-token
deleteWebhookAsync
Section titled “deleteWebhookAsync”Webhook . deleteWebhookAsync ( instance , webhookId , auditLogReason ) -> FutureLike<string, DeleteWebhookResponse>
https://discord.com/developers/docs/resources/webhook#delete-webhook
Parameters
| instance: Request | |
| webhookId: Snowflake | |
| auditLogReason: string? |
Returns
| FutureLike<string, DeleteWebhookResponse> |
deleteWebhookWithTokenAsync
Section titled “deleteWebhookWithTokenAsync”Webhook . deleteWebhookWithTokenAsync ( instance , webhookId , webhookToken , auditLogReason ) -> FutureLike<string, DeleteWebhookWitHTokenResponse>
https://discord.com/developers/docs/resources/webhook#delete-webhook-with-token
executeWebhookAsync
Section titled “executeWebhookAsync”Webhook . executeWebhookAsync ( instance , webhookId , webhookToken , jsonParams , urlParams ) -> FutureLike<string, ExecuteWebhookResponse>
https://discord.com/developers/docs/resources/webhook#execute-webhook
Parameters
| instance: Request | |
| webhookId: Snowflake | |
| webhookToken: string | |
| jsonParams: ExecuteWebhookRequest | |
| urlParams: { wait: boolean?, threadId: apiTypes.Snowflake?, } |
Returns
| FutureLike<string, ExecuteWebhookResponse> |
executeSlackCompatibleWebhookAsync
Section titled “executeSlackCompatibleWebhookAsync”Webhook . executeSlackCompatibleWebhookAsync ( instance , webhookId , webhookToken ) -> FutureLike< string, ExecuteSlackCompatibleWebhookResponse >
https://discord.com/developers/docs/resources/webhook#execute-slackcompatible-webhook
Parameters
| instance: Request | |
| webhookId: Snowflake | |
| webhookToken: string |
executeGithubCompatibleWebhookAsync
Section titled “executeGithubCompatibleWebhookAsync”Webhook . executeGithubCompatibleWebhookAsync ( instance , webhookId , webhookToken ) -> FutureLike< string, ExecuteGithubCompatibleWebhookResponse >
https://discord.com/developers/docs/resources/webhook#execute-githubcompatible-webhook
Parameters
| instance: Request | |
| webhookId: Snowflake | |
| webhookToken: string |
getWebhookMessageAsync
Section titled “getWebhookMessageAsync”Webhook . getWebhookMessageAsync ( instance , webhookId , webhookToken , messageId , urlParams ) -> FutureLike<string, GetWebhookMessageResponse>
https://discord.com/developers/docs/resources/webhook#get-webhook-message
Parameters
| instance: Request | |
| webhookId: Snowflake | |
| webhookToken: string | |
| messageId: Snowflake | |
| urlParams: { { threadId: apiTypes.Snowflake?, } } |
Returns
| FutureLike<string, GetWebhookMessageResponse> |
editWebhookMessageAsync
Section titled “editWebhookMessageAsync”Webhook . editWebhookMessageAsync ( instance , webhookId , webhookToken , messageId , jsonParams , urlParams ) -> FutureLike<string, EditWebhookMessageResponse>
https://discord.com/developers/docs/resources/webhook#edit-webhook-message
Parameters
| instance: Request | |
| webhookId: Snowflake | |
| webhookToken: string | |
| messageId: Snowflake | |
| jsonParams: EditWebhookMessageRequest | |
| urlParams: { { threadId: apiTypes.Snowflake?, } } |
Returns
| FutureLike<string, EditWebhookMessageResponse> |
deleteWebhookMessageAsync
Section titled “deleteWebhookMessageAsync”Webhook . deleteWebhookMessageAsync ( instance , webhookId , webhookToken , messageId , urlParams ) -> FutureLike<string, DeleteWebhookMessageResponse>
https://discord.com/developers/docs/resources/webhook#delete-webhook-message
Parameters
| instance: Request | |
| webhookId: Snowflake | |
| webhookToken: string | |
| messageId: Snowflake | |
| urlParams: { { threadId: apiTypes.Snowflake?, } } |
Returns
| FutureLike<string, DeleteWebhookMessageResponse> |