diff options
| author | Austin Hellyer <[email protected]> | 2016-11-07 11:43:15 -0800 |
|---|---|---|
| committer | Austin Hellyer <[email protected]> | 2016-11-07 11:43:15 -0800 |
| commit | a114a55efb5b08f9e5f289203db2dfd4db82852a (patch) | |
| tree | 8522e8eb3e77534ecf5c8e0208746b587eae887b /definitions/structs/webhook.yml | |
| parent | Add Attachment::download{,to_directory} (diff) | |
| download | serenity-a114a55efb5b08f9e5f289203db2dfd4db82852a.tar.xz serenity-a114a55efb5b08f9e5f289203db2dfd4db82852a.zip | |
Add webhook support
Diffstat (limited to 'definitions/structs/webhook.yml')
| -rw-r--r-- | definitions/structs/webhook.yml | 47 |
1 files changed, 47 insertions, 0 deletions
diff --git a/definitions/structs/webhook.yml b/definitions/structs/webhook.yml new file mode 100644 index 0000000..a2f3c4c --- /dev/null +++ b/definitions/structs/webhook.yml @@ -0,0 +1,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 |