Atlassian · Schema

Hook Event

An event, associated with a resource or subject type.

CodeCollaborationPlatformProductivitySoftware Development

Properties

Name Type Description
event string The event identifier.
category string The category this event belongs to.
label string Summary of the webhook event type.
description string More detailed description of the webhook event type.
View JSON Schema on GitHub

JSON Schema

atlassian-hook-event-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/hook_event",
  "title": "Hook Event",
  "type": "object",
  "description": "An event, associated with a resource or subject type.",
  "properties": {
    "event": {
      "type": "string",
      "description": "The event identifier.",
      "enum": [
        "pullrequest:comment_reopened",
        "pullrequest:approved",
        "issue:comment_created",
        "repo:push",
        "pullrequest:comment_deleted",
        "pullrequest:fulfilled",
        "pullrequest:comment_created",
        "pullrequest:comment_updated",
        "pullrequest:updated",
        "repo:commit_status_created",
        "pullrequest:unapproved",
        "repo:updated",
        "pullrequest:comment_resolved",
        "repo:transfer",
        "repo:commit_status_updated",
        "pullrequest:changes_request_created",
        "issue:updated",
        "repo:created",
        "pullrequest:changes_request_removed",
        "pullrequest:rejected",
        "pullrequest:created",
        "issue:created",
        "repo:imported",
        "repo:commit_comment_created",
        "project:updated",
        "repo:fork",
        "repo:deleted"
      ]
    },
    "category": {
      "type": "string",
      "description": "The category this event belongs to."
    },
    "label": {
      "type": "string",
      "description": "Summary of the webhook event type."
    },
    "description": {
      "type": "string",
      "description": "More detailed description of the webhook event type."
    }
  },
  "additionalProperties": false
}