GitHubWebhook
Related endpoints| Field | Type | Description |
|---|---|---|
| action? | ?string | |
| answer? | ?GitHubWebhookAnswer | |
| check_run? | ?GitHubWebhookCheckRun | |
| check_suite? | ?GitHubWebhookCheckSuite | |
| comment? | ?GitHubWebhookAnswer | |
| commits? | ?GitHubWebhookCommitsItem[] | |
| compare? | ?string | |
| discussion? | ?GitHubWebhookDiscussion | |
| forced? | ?boolean | |
| forkee? | ?GitHubWebhookForkee | |
| head_commit? | ?GitHubWebhookCommitsItem | |
| issue? | ?GitHubWebhookIssue | |
| member? | ?GitHubWebhookMember | |
| pull_request? | ?GitHubWebhookIssue | |
| ref? | ?string | |
| ref_type? | ?string | |
| release? | ?GitHubWebhookRelease | |
| repository? | ?GitHubWebhookForkee | |
| review? | ?GitHubWebhookReview | |
| sender | GitHubWebhookMember |
SentryWebhook
Related endpoints| Field | Type | Description |
|---|---|---|
| action? | ?string | |
| actor? | ?SentryWebhookActor | |
| data? | ?SentryWebhookData | |
| installation? | ?SentryWebhookInstallation |
SlackWebhookRequest
Related endpoints| Field | Type | Description |
|---|---|---|
| attachments? | SlackWebhookRequestAttachmentsItem[] | Array of attachment objects |
| icon_url? | string | Override the default icon of the webhook |
| text? | string | Main text content of the message |
| username? | string | Override the default username of the webhook |
WebhookCreateRequest
Related endpoints| Field | Type | Description |
|---|---|---|
| avatar? | ?Base64ImageType | The avatar image as a base64-encoded data URI |
| name | string | The name of the webhook |
WebhookResponse
Related endpointsGET /channels/{channel_id}/webhooksGET /guilds/{guild_id}/webhooksGET /webhooks/{webhook_id}POST /channels/{channel_id}/webhooksPATCH /webhooks/{webhook_id}
| Field | Type | Description |
|---|---|---|
| avatar? | ?string | The hash of the webhook avatar image |
| channel_id | SnowflakeType | The ID of the channel this webhook posts to |
| guild_id | SnowflakeType | The ID of the guild this webhook belongs to |
| id | SnowflakeType | The unique identifier (snowflake) for the webhook |
| name | string | The display name of the webhook |
| token | string | The secure token used to execute the webhook |
| user | UserPartialResponse |
WebhookTokenResponse
Related endpoints| Field | Type | Description |
|---|---|---|
| avatar? | ?string | The hash of the webhook avatar image |
| channel_id | SnowflakeType | The ID of the channel this webhook posts to |
| guild_id | SnowflakeType | The ID of the guild this webhook belongs to |
| id | SnowflakeType | The unique identifier (snowflake) for the webhook |
| name | string | The display name of the webhook |
| token | string | The secure token used to execute the webhook |
WebhookTokenUpdateRequest
Related endpoints| Field | Type | Description |
|---|---|---|
| avatar? | ?Base64ImageType | The new avatar image as a base64-encoded data URI |
| name? | string | The new name of the webhook |
WebhookType
The type of webhook| Value | Description |
|---|---|
1 | Incoming webhook |
2 | Channel follower webhook |
WebhookUpdateRequest
Related endpoints| Field | Type | Description |
|---|---|---|
| avatar? | ?Base64ImageType | The new avatar image as a base64-encoded data URI |
| channel_id? | SnowflakeType | |
| name? | string | The new name of the webhook |
GitHubWebhookAnswer
| Field | Type | Description |
|---|---|---|
| body | string | |
| commit_id? | ?SnowflakeType | |
| html_url | string | |
| id | Int64Type | |
| user | GitHubWebhookMember |
GitHubWebhookCheckRun
| Field | Type | Description |
|---|---|---|
| check_suite | GitHubWebhookCheckSuite | |
| conclusion? | ?string | |
| details_url? | ?string | |
| html_url | string | |
| name | string | |
| output? | ?GitHubWebhookCheckRunOutput | |
| pull_requests? | ?GitHubWebhookCheckRunPullRequestsItem[] |
GitHubWebhookCheckSuite
| Field | Type | Description |
|---|---|---|
| app | GuildEmojiUpdateRequest | |
| conclusion? | ?string | |
| head_branch? | ?string | |
| head_sha | string | |
| pull_requests? | ?GitHubWebhookCheckRunPullRequestsItem[] |
GitHubWebhookCommitsItem
| Field | Type | Description |
|---|---|---|
| author | GitHubWebhookCommitsItemAuthor | |
| id | SnowflakeType | |
| message | string | |
| url | string |
GitHubWebhookDiscussion
| Field | Type | Description |
|---|---|---|
| answer_html_url? | ?string | |
| body? | ?string | |
| html_url | string | |
| number | Int32Type | |
| title | string | |
| user | GitHubWebhookMember |
GitHubWebhookForkee
| Field | Type | Description |
|---|---|---|
| full_name | string | |
| html_url | string | |
| id | Int32Type | |
| name | string |
GitHubWebhookIssue
| Field | Type | Description |
|---|---|---|
| body? | ?string | |
| html_url | string | |
| id | Int64Type | |
| number | Int32Type | |
| title | string | |
| user | GitHubWebhookMember |
GitHubWebhookMember
| Field | Type | Description |
|---|---|---|
| avatar_url | string | |
| html_url | string | |
| id | Int32Type | |
| login | string |
GitHubWebhookRelease
| Field | Type | Description |
|---|---|---|
| body? | ?string | |
| html_url | string | |
| id | Int32Type | |
| tag_name | string |
GitHubWebhookReview
| Field | Type | Description |
|---|---|---|
| body? | ?string | |
| html_url | string | |
| state | string | |
| user | GitHubWebhookMember |
SentryWebhookActor
| Field | Type | Description |
|---|---|---|
| id | SnowflakeType | |
| name | string | |
| type | string |
SentryWebhookData
| Field | Type | Description |
|---|---|---|
| issue | SentryWebhookDataIssue |
SentryWebhookInstallation
| Field | Type | Description |
|---|---|---|
| uuid | string |
SlackWebhookRequestAttachmentsItem
Array of attachment objects| Field | Type | Description |
|---|---|---|
| author_icon? | string | URL for the author icon image |
| author_link? | string | URL to link from the author name |
| author_name? | string | Name of the author |
| color? | string | Colour of the attachment sidebar (hex code or preset) |
| fallback? | string | Fallback text for notifications |
| fields? | SlackWebhookRequestAttachmentsItemFieldsItem[] | Array of field objects |
| footer? | string | Footer text displayed at the bottom |
| image_url? | string | URL of the main image to display |
| pretext? | string | Text that appears above the attachment block |
| text? | string | Main text content of the attachment |
| thumb_url? | string | URL of a thumbnail image |
| title? | string | Title of the attachment |
| title_link? | string | URL to link from the title |
| ts? | integer (int64) | Unix timestamp for the attachment footer |