Webhook Resource

Webhooks are a low-effort way to post messages to channels in Discord. They do not require a bot user or authentication to use.

Used to represent a webhook.

¹ For application-owned webhooks, this field is only returned to the application that created the webhook.

² These fields will not be included if the webhook creator has since lost access to the followed channel's guild.

{
  "application_id": null,
  "avatar": null,
  "channel_id": "199737254929760256",
  "guild_id": "199737254929760256",
  "id": "223704706495545344",
  "name": "test webhook",
  "type": 1,
  "user": {
    "id": "828387742575624222",
    "username": "jupppper",
    "avatar": "e14a7c62b0b38068be88be194b23910f",
    "discriminator": "0",
    "public_flags": 16384,
    "banner": null,
    "accent_color": null,
    "global_name": "Jup",
    "avatar_decoration_data": null
  },
  "token": "3d89bb7572e0fb30d8128367b3b1b44fecd1726de135cbe28a41f8b2f777c372ba2939e72279b94526ff5d1bd4358d65cf11",
  "url": "https://discord.com/api/webhooks/223704706495545344/3d89bb7572e0fb30d8128367b3b1b44fecd1726de135cbe28a41f8b2f777c372ba2939e72279b94526ff5d1bd4358d65cf11"
}

{
  "application_id": null,
  "avatar": "bb71f469c158984e265093a81b3397fb",
  "channel_id": "561885260615255432",
  "guild_id": "56188498421443265",
  "id": "752831914402115456",
  "name": "Guildy name",
  "type": 2,
  "source_guild": {
    "id": "56188498421476534",
    "name": "Guildy name",
    "icon": "bb71f469c158984e265093a81b3397fb"
  },
  "source_channel": {
    "id": "5618852344134324",
    "name": "announcements"
  },
  "user": {
    "id": "828387742575624222",
    "username": "jupppper",
    "avatar": "e14a7c62b0b38068be88be194b23910f",
    "discriminator": "0",
    "public_flags": 16384,
    "banner": null,
    "accent_color": null,
    "global_name": "Jup",
    "avatar_decoration_data": null
  }
}

{
  "application_id": "658822586720976555",
  "avatar": "689161dc90ac261d00f1608694ac6bfd",
  "channel_id": null,
  "guild_id": null,
  "id": "658822586720976555",
  "name": "Clyde",
  "type": 3,
  "user": null
}

Creates a new webhook. Requires the MANAGE_WEBHOOKS permission. Returns a webhook object on success. Fires a Webhooks Update Gateway event.

Returns a list of channel webhook objects. Requires the MANAGE_WEBHOOKS permission.

Returns a list of guild webhook objects. Requires the MANAGE_WEBHOOKS permission.

Returns a webhook object for the given webhook ID.

Same as above, except this call does not require authentication.

Modifies a webhook. Requires the MANAGE_WEBHOOKS permission. Returns the updated webhook object on success. Fires a Webhooks Update Gateway event.

Same as above, except this call does not require authentication and does not accept a channel_id parameter.

Deletes a webhook permanently. Requires the MANAGE_WEBHOOKS permission. Returns a 204 empty response on success. Fires a Webhooks Update Gateway event.

Same as above, except this call does not require authentication.

Posts a message to the webhook's channel. Returns a message object or 204 empty response, depending on wait. Fires a Message Create Gateway event. See message formatting for more information on how to properly format messages.

Files must be attached using a multipart/form-data body (or pre-uploaded to Discord's GCP bucket) as described in Uploading Files.

• When executing on a forum channel, one of thread_id or thread_name must be provided.
• The maximum request size when sending a message is 100 MiB.
• For the embed object, you can set every field except type (it will be rich regardless of if you try to set it), provider, video, and any height, width, or proxy_url values for images.

¹ See Uploading Files for details.

² Requires an application-owned webhook.

Refer to Slack's documentation for more information. We do not support Slack's channel, icon_emoji, mrkdwn, or mrkdwn_in properties.

Add a new webhook to your GitHub repo (in the repo's settings), and use this endpoint as the "Payload URL". You can choose what events your Discord channel receives by choosing the "Let me select individual events" option and selecting individual events for the new webhook you're configuring. The supported events are commit_comment, create, delete, fork, issue_comment, issues, member, public, pull_request, pull_request_review, pull_request_review_comment, push, release, watch, check_run, check_suite, discussion, and discussion_comment.

Returns a previously-sent webhook message object from the same token.

Edits a previously-sent webhook message from the same token. Returns the updated message object on success. Fires a Message Update Gateway event.

When the content field is edited, the mentions array in the message object will be reconstructed from scratch based on the new content. The allowed_mentions field of the edit request controls how this happens. If there is no explicit allowed_mentions in the edit request, the content will be parsed with default allowances, that is, without regard to whether or not an allowed_mentions was present in the request that originally created the message.

Refer to Uploading Files for details on attachments and multipart/form-data requests. Any provided files will be appended to the message. To remove or replace files you will have to supply the attachments field which specifies the files to retain on the message after edit.

¹ See Uploading Files for details.

² Requires an application-owned webhook.

Deletes a message that was created by the webhook. Returns a 204 empty response on success. Fires a Message Delete Gateway event.