issue.create
IssueCreate event - represents creation of a new issue
CI execution_ref: Default branch.
can-trigger-ci: true
REQUEST BODY SCHEMA: application/json
required
|
Field |
Description |
|
object (Common header included in all public events) |
|
|
object (Repository) |
|
|
object (Issue) |
header
|
Field |
Description |
|
|
string (Unique identifier for this event instance) |
|
|
string (Event type) |
|
|
string <date-time> (When the event occurred) |
|
|
string (ID of the primary entity this event is about) |
|
|
string (Type of the primary entity (derived from event_type)) |
|
object (Public metadata) |
|
|
|
string (Organization context) |
|
|
string (Repository context) |
|
object (UserEmbedded) |
|
|
|
string |
|
|
string |
header.metadata
|
Field |
Description |
|
|
string |
header.triggered_by
|
Field |
Description |
|
|
string (Id will contain "<external-user>" if user is external) |
|
|
string (Slug will contain "<external-user>" if user is external) |
repository
|
Field |
Description |
|
|
string |
|
|
string |
|
|
string |
|
object (OrganizationEmbedded) |
|
|
|
string |
|
|
string (RepoTemplate) Enum: |
|
|
boolean |
|
|
string |
|
|
string (Repository.Visibility) Enum: |
|
object (Image) |
|
|
object (CloneURL) |
|
|
|
string |
|
Array of objects (Link) |
|
|
object (RepositoryCounters) |
|
|
|
string <date-time> |
|
object (Language) |
|
|
object (RepositoryEmbedded) |
|
|
object (MigrationSource) |
|
|
object (ProjectEmbedded) |
|
|
object (RepositoryRating) |
|
|
object (RepositorySettings) |
repository.organization
|
Field |
Description |
|
|
string |
|
|
string |
repository.logo
|
Field |
Description |
|
|
string |
repository.clone_url
|
Field |
Description |
|
|
string |
|
|
string |
repository.links
|
Field |
Description |
|
|
string |
|
|
string (Link.LinkType) Enum: |
repository.counters
|
Field |
Description |
|
|
string <uint64> |
|
|
string <uint64> |
|
|
string <uint64> |
|
|
string <uint64> |
|
|
string <uint64> |
repository.language
|
Field |
Description |
|
|
string |
|
|
string |
repository.parent
|
Field |
Description |
|
|
string |
|
|
string |
|
object (OrganizationEmbedded) |
repository.parent.organization
|
Field |
Description |
|
|
string |
|
|
string |
repository.migration_source
|
Field |
Description |
|
|
string |
|
|
string |
repository.project
|
Field |
Description |
|
|
string |
|
|
string |
repository.rating
|
Field |
Description |
|
|
number <double> |
|
|
number <double> |
|
Array of objects (RepositoryRatingReactionCount) |
repository.rating.reaction_counts
|
Field |
Description |
|
|
string (RepositoryRatingReaction.Type)
Enum: |
|
|
string <uint64> |
repository.settings
|
Field |
Description |
|
|
boolean |
issue
|
Field |
Description |
|
|
string |
|
|
string |
|
|
string |
|
|
string |
|
object (IssueStatus) |
|
|
object (UserEmbedded) |
|
|
object (UserEmbedded) |
|
|
|
string <date-time> |
|
|
string <date-time> |
|
object (UserEmbedded) |
|
|
Array of objects (LabelEmbedded) |
|
|
Array of objects (PullRequestEmbedded) |
|
|
|
string (mapping is done by const name, except for the unspecified) Enum: |
|
|
string (Issue.Visibility) Enum: |
|
object (MilestoneEmbedded) |
|
|
|
string <date-time> (User-defined deadline for the issue) |
|
|
string <date-time> (Timestamp when the issue was last moved to in_progress status) |
|
|
string <date-time> (Timestamp when the issue was last moved to completed or canceled status) |
|
object (RepositoryEmbedded) |
issue.status
|
Field |
Description |
|
|
string |
|
|
string |
|
|
string |
|
|
string (StatusType) Enum: |
issue.author
|
Field |
Description |
|
|
string (Id will contain "<external-user>" if user is external) |
|
|
string (Slug will contain "<external-user>" if user is external) |
issue.updated_by
|
Field |
Description |
|
|
string (Id will contain "<external-user>" if user is external) |
|
|
string (Slug will contain "<external-user>" if user is external) |
issue.assignee
|
Field |
Description |
|
|
string (Id will contain "<external-user>" if user is external) |
|
|
string (Slug will contain "<external-user>" if user is external) |
issue.labels
|
Field |
Description |
|
|
string |
|
|
string |
|
|
string |
|
|
string |
issue.linked_prs
|
Field |
Description |
|
|
string |
|
|
string |
issue.milestone
|
Field |
Description |
|
|
string |
|
|
string |
issue.repository
|
Field |
Description |
|
|
string |
|
|
string |
|
object (OrganizationEmbedded) |
issue.repository.organization
|
Field |
Description |
|
|
string |
|
|
string |
Request samples
{
"$ref": "#/components/schemas/IssueCreate",
"components": {
"schemas": {
"IssueCreate": {
"type": "object",
"properties": {
"header": {
"$ref": "#/components/schemas/EventHeader"
},
"repository": {
"$ref": "#/components/schemas/Repository"
},
"issue": {
"$ref": "#/components/schemas/Issue"
}
},
"title": "IssueCreate event - represents creation of a new issue"
},
"EventHeader": {
"type": "object",
"properties": {
"id": {
"type": "string",
"title": "Unique identifier for this event instance"
},
"type": {
"type": "string",
"title": "Event type"
},
"occurred_at": {
"type": "string",
"format": "date-time",
"title": "When the event occurred"
},
"aggregate_id": {
"type": "string",
"title": "ID of the primary entity this event is about"
},
"aggregate_type": {
"type": "string",
"title": "Type of the primary entity (derived from event_type)"
},
"metadata": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"title": "Public metadata"
},
"organization_id": {
"type": "string",
"title": "Organization context"
},
"repository_id": {
"type": "string",
"title": "Repository context"
},
"triggered_by": {
"$ref": "#/components/schemas/UserEmbedded"
},
"correlation_id": {
"type": "string",
"description": "Correlation ID for tracking event chains back to the original request.\nUses request_id from the originating gRPC/HTTP request when available,\nfalls back to trace_id or the root event's ID."
},
"causation_id": {
"type": "string",
"description": "Causation ID is the ID of the event that directly caused this event.\nEmpty for root events (events triggered directly by user actions).\nUsed to reconstruct the event tree within a correlation chain."
}
},
"title": "Common header included in all public events"
},
"UserEmbedded": {
"type": "object",
"properties": {
"id": {
"type": "string",
"title": "Id will contain \"<external-user>\" if user is external"
},
"slug": {
"type": "string",
"title": "Slug will contain \"<external-user>\" if user is external"
}
}
},
"Repository": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string",
"description": "Deprecated: obsolete, prefer using slug. Will be removed in future API iterations."
},
"default_branch": {
"type": "string"
},
"organization": {
"$ref": "#/components/schemas/OrganizationEmbedded"
},
"slug": {
"type": "string"
},
"template_type": {
"$ref": "#/components/schemas/RepoTemplate"
},
"is_empty": {
"type": "boolean"
},
"description": {
"type": "string"
},
"visibility": {
"$ref": "#/components/schemas/Repository.Visibility"
},
"logo": {
"$ref": "#/components/schemas/Image"
},
"clone_url": {
"$ref": "#/components/schemas/CloneURL"
},
"web_url": {
"type": "string"
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Link"
}
},
"counters": {
"$ref": "#/components/schemas/RepositoryCounters"
},
"last_updated": {
"type": "string",
"format": "date-time"
},
"language": {
"$ref": "#/components/schemas/Language"
},
"parent": {
"$ref": "#/components/schemas/RepositoryEmbedded"
},
"migration_source": {
"$ref": "#/components/schemas/MigrationSource"
},
"project": {
"$ref": "#/components/schemas/ProjectEmbedded"
},
"rating": {
"$ref": "#/components/schemas/RepositoryRating"
},
"settings": {
"$ref": "#/components/schemas/RepositorySettings"
}
}
},
"OrganizationEmbedded": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"slug": {
"type": "string"
}
}
},
"RepoTemplate": {
"type": "string",
"enum": [
"not_a_template",
"organizational",
"system"
]
},
"Repository.Visibility": {
"type": "string",
"enum": [
"public",
"internal",
"private"
]
},
"Image": {
"type": "object",
"properties": {
"url": {
"type": "string"
}
}
},
"CloneURL": {
"type": "object",
"properties": {
"https": {
"type": "string"
},
"ssh": {
"type": "string"
}
}
},
"Link": {
"type": "object",
"properties": {
"link": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/Link.LinkType"
}
}
},
"Link.LinkType": {
"type": "string",
"enum": [
"default",
"social_network",
"homepage",
"email",
"telegram"
]
},
"RepositoryCounters": {
"type": "object",
"properties": {
"forks": {
"type": "string",
"format": "uint64"
},
"pull_requests": {
"type": "string",
"format": "uint64"
},
"issues": {
"type": "string",
"format": "uint64"
},
"tags": {
"type": "string",
"format": "uint64"
},
"branches": {
"type": "string",
"format": "uint64"
}
}
},
"Language": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"color": {
"type": "string"
}
}
},
"RepositoryEmbedded": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"slug": {
"type": "string"
},
"organization": {
"$ref": "#/components/schemas/OrganizationEmbedded"
}
}
},
"MigrationSource": {
"type": "object",
"properties": {
"url": {
"type": "string"
},
"domain": {
"type": "string"
}
}
},
"ProjectEmbedded": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"slug": {
"type": "string"
}
}
},
"RepositoryRating": {
"type": "object",
"properties": {
"value": {
"type": "number",
"format": "double",
"description": "Current repository rating value."
},
"percentile": {
"type": "number",
"format": "double",
"description": "Repository percentile among rated repositories. Omitted while percentile data is unavailable."
},
"reaction_counts": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RepositoryRatingReactionCount"
},
"description": "Reaction counters grouped by reaction type."
}
},
"description": "Aggregated rating information for a repository."
},
"RepositoryRatingReactionCount": {
"type": "object",
"properties": {
"type": {
"$ref": "#/components/schemas/RepositoryRatingReaction.Type"
},
"count": {
"type": "string",
"format": "uint64"
}
},
"description": "Number of rating reactions of a particular type."
},
"RepositoryRatingReaction.Type": {
"type": "string",
"enum": [
"none",
"positive_low",
"positive_medium",
"positive_high"
],
"description": " - none: Remove the current user's rating reaction.\n - positive_low: A low positive rating reaction. Corresponds to Like in the SourceCraft interface.\n - positive_medium: A medium positive rating reaction. Corresponds to Heart in the SourceCraft interface.\n - positive_high: A high positive rating reaction. Corresponds to Diamond in the SourceCraft interface."
},
"RepositorySettings": {
"type": "object",
"properties": {
"allow_external_contributions": {
"type": "boolean",
"description": "Whether authenticated users without organization or repository access can contribute to a public repository.\nHas no effect on non-public repositories."
}
}
},
"Issue": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"slug": {
"type": "string"
},
"title": {
"type": "string"
},
"description": {
"type": "string"
},
"status": {
"$ref": "#/components/schemas/IssueStatus"
},
"author": {
"$ref": "#/components/schemas/UserEmbedded"
},
"updated_by": {
"$ref": "#/components/schemas/UserEmbedded"
},
"created_at": {
"type": "string",
"format": "date-time"
},
"updated_at": {
"type": "string",
"format": "date-time"
},
"assignee": {
"$ref": "#/components/schemas/UserEmbedded"
},
"labels": {
"type": "array",
"items": {
"$ref": "#/components/schemas/LabelEmbedded"
}
},
"linked_prs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PullRequestEmbedded"
}
},
"priority": {
"$ref": "#/components/schemas/Priority"
},
"visibility": {
"$ref": "#/components/schemas/Issue.Visibility"
},
"milestone": {
"$ref": "#/components/schemas/MilestoneEmbedded"
},
"deadline": {
"type": "string",
"format": "date-time",
"title": "User-defined deadline for the issue"
},
"started_at": {
"type": "string",
"format": "date-time",
"title": "Timestamp when the issue was last moved to in_progress status"
},
"completed_at": {
"type": "string",
"format": "date-time",
"title": "Timestamp when the issue was last moved to completed or canceled status"
},
"repository": {
"$ref": "#/components/schemas/RepositoryEmbedded"
}
}
},
"IssueStatus": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"slug": {
"type": "string"
},
"name": {
"type": "string"
},
"status_type": {
"$ref": "#/components/schemas/StatusType"
}
}
},
"StatusType": {
"type": "string",
"enum": [
"initial",
"in_progress",
"paused",
"completed",
"cancelled"
]
},
"LabelEmbedded": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"slug": {
"type": "string"
},
"name": {
"type": "string"
},
"color": {
"type": "string"
}
}
},
"PullRequestEmbedded": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"slug": {
"type": "string"
}
}
},
"Priority": {
"type": "string",
"enum": [
"trivial",
"minor",
"normal",
"critical",
"blocker"
],
"title": "mapping is done by const name, except for the unspecified"
},
"Issue.Visibility": {
"type": "string",
"enum": [
"public",
"private"
]
},
"MilestoneEmbedded": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"slug": {
"type": "string"
}
}
}
}
}
}