Skip to content

Commit 2366a0e

Browse files
chore(webhooks): Update issue webhook docs (#15459)
1 parent 23d402f commit 2366a0e

File tree

1 file changed

+59
-37
lines changed
  • docs/organization/integrations/integration-platform/webhooks

1 file changed

+59
-37
lines changed

docs/organization/integrations/integration-platform/webhooks/issues.mdx

Lines changed: 59 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -58,56 +58,78 @@ A status can mean multiple things, so substatus gives more details about the sta
5858
* `ignoreUserWindow`: Used with `ignoreUserCount` indicating the number of minutes that `ignoreUserCount` affected users will be ignored
5959
* `ignoreDuration`: The duration (in minutes) that an archived issue should be ignored before it gets escalated. Increase in the number of users affected or the number of occurrences will not escalate before this duration has passed unless there is a spike. To learn more about how this works, see [Escalating Issues Algorithm](/product/issues/states-triage/escalating-issues/).
6060

61+
### issueCategory & issueType
62+
`issueCategory` and `issueType` provide more detail to distinguish different issues from eachother. For `issueCategory` variations include, `outage` (for issues created from `uptime` and `cron` monitors) and `error` (for issues created from an error event).
63+
64+
`issueType` allows for even more specificity on top of `issueCategory`, examples include `uptime_domain_failure` for `uptime` issues and `monitor_check_in_failure` for `cron` issues.
65+
66+
The issue categories we currently support `issue.created` webhooks for are `OUTAGE`, `ERROR`, and FEEDBACK.
67+
6168
```json
6269
{
6370
"action": "created",
64-
"actor": {
65-
"id": "sentry",
66-
"name": "Sentry",
67-
"type": "application"
71+
"installation": {
72+
"uuid": "24b397fc-a86e-43ef-9297-949e21b82480"
6873
},
6974
"data": {
7075
"issue": {
71-
"annotations": [],
72-
"assignedTo": null,
73-
"count": "1",
74-
"culprit": "?(runner)",
75-
"firstSeen": "2019-08-19T20:58:37.391000Z",
76-
"hasSeen": false,
77-
"id": "1170820242",
78-
"isBookmarked": false,
76+
"url": "https://sentry.io/api/0/organizations/example-org/issues/1234567890/",
77+
"web_url": "https://example-org.sentry.io/issues/1234567890/",
78+
"project_url": "https://example-org.sentry.io/issues/?project=4509877862268928",
79+
"id": "1234567890",
80+
"shareId": null,
81+
"shortId": "PYTHON-Y",
82+
"title": "Error generated with event_id: 495d375a-1df6-45c0-9890-34dae8e1b6a4(Priority: HIGH)",
83+
"culprit": "test-transaction-0-41e49cd3-7252-441f-8d27-63a9ad697b0a",
84+
"permalink": "https://example-org.sentry.io/issues/1234567890/",
85+
"logger": "edge-function",
86+
"level": "fatal",
87+
"status": "unresolved",
88+
"statusDetails": {},
89+
"substatus": "new",
7990
"isPublic": false,
80-
"isSubscribed": false,
81-
"lastSeen": "2019-08-19T20:58:37.391000Z",
82-
"level": "error",
83-
"logger": null,
84-
"metadata": {
85-
"filename": "/runner",
86-
"type": "ReferenceError",
87-
"value": "blooopy is not defined"
88-
},
89-
"numComments": 0,
90-
"permalink": null,
9191
"platform": "javascript",
9292
"project": {
93-
"id": "1",
94-
"name": "front-end",
95-
"platform": "",
96-
"slug": "front-end"
93+
"id": "112313123123134",
94+
"name": "python",
95+
"slug": "python",
96+
"platform": "python"
9797
},
98-
"shareId": null,
99-
"shortId": "FRONT-END-9",
100-
"status": "unresolved",
101-
"statusDetails": {},
98+
"type": "default",
99+
"metadata": {
100+
"title": "Error generated with event_id: 495d375a-1df6-45c0-9890-34dae8e1b6a4(Priority: HIGH)",
101+
"sdk": {
102+
"name": "edge-function",
103+
"name_normalized": "other"
104+
},
105+
"severity": 1,
106+
"severity_reason": "log_level_fatal",
107+
"initial_priority": 75
108+
},
109+
"numComments": 0,
110+
"assignedTo": null,
111+
"isBookmarked": false,
112+
"isSubscribed": false,
102113
"subscriptionDetails": null,
103-
"substatus": "escalating",
104-
"title": "ReferenceError: blooopy is not defined",
105-
"type": "error",
106-
"userCount": 1
114+
"hasSeen": false,
115+
"annotations": [],
116+
"issueType": "error",
117+
"issueCategory": "error",
118+
"priority": "high",
119+
"priorityLockedAt": null,
120+
"seerFixabilityScore": null,
121+
"seerAutofixLastTriggered": null,
122+
"isUnhandled": false,
123+
"count": "3",
124+
"userCount": 3,
125+
"firstSeen": "2025-11-10T20:56:00.679000+00:00",
126+
"lastSeen": "2025-11-10T20:56:00.738000+00:00"
107127
}
108128
},
109-
"installation": {
110-
"uuid": "a8e5d37a-696c-4c54-adb5-b3f28d64c7de"
129+
"actor": {
130+
"type": "application",
131+
"id": "example-app",
132+
"name": "Example App"
111133
}
112134
}
113135
```

0 commit comments

Comments
 (0)