Preview integration resources as incidents
GET /v1/integrations/{name}/incidents/import
Parameters
Section titled “ Parameters ”Path Parameters
Section titled “Path Parameters ”Integration vendor short name (e.g. ‘jira’, ‘wiz’, ‘bugcrowd’)
Responses
Section titled “ Responses ”Preview incident integration resources before importing
Paginated list envelope: { "results": [...], "pagination": {...} }.
object
Pagination metadata for external-integration responses. The continuation is
a single opaque next_page_token — a base64(JSON)
blob the producer round-trips through [crate::views::cursor] — so the
page/offset/cursor schemes of the underlying APIs are invisible to the
SDK/frontend, which only read total_items for the “X of Y” display.
object
Opaque continuation token. Absent means there are no further pages — the sole end-of-collection signal.
Total matching items, when the upstream API reports it. Informational only — never used for loop control. Absent when the API reports no total (e.g. HackerOne, GitHub Dependabot).
The items on this page.
Relationship, core incident information
object
A User as returned by the API.
Profile images are not embedded — clients fetch them from
GET /api/v1/{icon} when icon is Some.
object
Relative path to the user’s avatar endpoint, e.g.
"users/{id}/avatar?v={hash}". None when the user has no avatar.
Example
INC-00001A User as returned by the API.
Profile images are not embedded — clients fetch them from
GET /api/v1/{icon} when icon is Some.
object
Relative path to the user’s avatar endpoint, e.g.
"users/{id}/avatar?v={hash}". None when the user has no avatar.
When set, this incident is linked under the named parent incident.
Example
INC-00001Where the incident was reported from (e.g. “Employee Reported”). Always present.
The status of an incident
A User as returned by the API.
Profile images are not embedded — clients fetch them from
GET /api/v1/{icon} when icon is Some.
object
Relative path to the user’s avatar endpoint, e.g.
"users/{id}/avatar?v={hash}". None when the user has no avatar.