aboutsummaryrefslogtreecommitdiff
path: root/definitions/structs/webhook.yml
blob: a2f3c4cd8440ea0eefc9cd8349bcac4b31836ed1 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
---
name: Webhook
description: >
  A representation of a webhook, which is a low-effort way to post messages to
  channels. They do not necessarily require a bot user or authentication to use.
fields:
  - name: id
    description: The Id of the webhook.
    type: WebhookId
  - name: avatar
    description: >
      The default avatar of the webhook. Note that this can be modified with a
      payload.
    optional: true
    type: string
  - name: channel_id
    description: >
      The Id of the [channel][`PublicChannel`] that owns the webhook.


        [`PublicChannel`]: struct.PublicChannel.html
    type: ChannelId
  - name: guild_id
    description: >
      The Id of the [`Guild`] that owns the webhook.


        [`Guild`]: struct.Guild.html
    optional: true
    type: GuildId
  - name: name
    description: >
      The default name of the webhook. Note that this can be modified in a
      payload.
    optional: true
    type: string
  - name: token
    description: The webhook's secure token.
    type: string
  - name: user
    description: >
      The user that created the webhook.


      **Note**: This is not returned when getting a webhook by its token.
    optional: true
    type: User