Skip to content

Give a register item a ticket

POST
/v1/integrations/{provider}/{installation_id}/configs/{config_id}/tickets/{target_id}
curl --request POST \
--url https://api.adversarial.com/api/v1/integrations/example/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/configs/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/tickets/1 \
--header 'Content-Type: application/json' \
--data '{ "epic": "example", "existing_key": "example", "project": "example" }'

Opens a new provider ticket, or links an existing one when the request names its key.

provider
required
string
installation_id
required
string format: uuid
config_id
required
string format: uuid
target_id
required
integer format: int64
Media typeapplication/json

How a register item gets its ticket.

object
epic

Optional Jira epic for a newly-created ticket.

string | null
existing_key

Provider-side key of a ticket to link instead of opening a new one.

string | null
project

Provider-side project, Linear team key, or ServiceNow table.

string | null
Examplegenerated
{
"epic": "example",
"existing_key": "example",
"project": "example"
}

The linked ticket

Media typeapplication/json

A generic preview of an external ticket for autocomplete and linked-ticket display. Works across all ticket integrations (Jira, ServiceNow, etc.).

object
available
required

false when the external system no longer returns this ticket (a dangling link kept visible only so the user can unlink it); true for live tickets. Synthesized unresolved previews set this to false.

boolean
id
required

Opaque external ticket ID.

string
image
required

Icon URL for the ticket type.

string
key
required

Human-readable ticket key (e.g. “PROJ-123”, “INC0012345”).

string
summary
required

Short summary/title.

string
table

The source table the ticket lives in (e.g. “incident”); null when the integration has no such concept.

string | null
url
required

URL to view the ticket in the external system.

string
Examplegenerated
{
"available": true,
"id": "example",
"image": "example",
"key": "example",
"summary": "example",
"table": "example",
"url": "example"
}

Register item or configuration not found

The ticket is already linked to the register item