Atlassian · Schema

WebhookDetails

A list of webhooks.

CodeCollaborationPlatformProductivitySoftware Development

Properties

Name	Type	Description
events	array	The Jira events that trigger the webhook.
fieldIdsFilter	array	A list of field IDs. When the issue changelog contains any of the fields, the webhook `jira:issue_updated` is sent. If this parameter is not present, the app is notified about all field updates.
issuePropertyKeysFilter	array	A list of issue property keys. A change of those issue properties triggers the `issue_property_set` or `issue_property_deleted` webhooks. If this parameter is not present, the app is notified about al
jqlFilter	string	The JQL filter that specifies which issues the webhook is sent for. Only a subset of JQL can be used. The supported elements are: * Fields: `issueKey`, `project`, `issuetype`, `status`, `assignee`, `r

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/WebhookDetails",
  "title": "WebhookDetails",
  "additionalProperties": false,
  "description": "A list of webhooks.",
  "properties": {
    "events": {
      "description": "The Jira events that trigger the webhook.",
      "items": {
        "enum": [
          "jira:issue_created",
          "jira:issue_updated",
          "jira:issue_deleted",
          "comment_created",
          "comment_updated",
          "comment_deleted",
          "issue_property_set",
          "issue_property_deleted"
        ],
        "type": "string"
      },
      "type": "array"
    },
    "fieldIdsFilter": {
      "description": "A list of field IDs. When the issue changelog contains any of the fields, the webhook `jira:issue_updated` is sent. If this parameter is not present, the app is notified about all field updates.",
      "items": {
        "description": "A list of field IDs. When the issue changelog contains any of the fields, the webhook <code>jira:issue_updated</code> is sent. If this parameter is not present, the app is notified about all field updates.",
        "type": "string"
      },
      "type": "array"
    },
    "issuePropertyKeysFilter": {
      "description": "A list of issue property keys. A change of those issue properties triggers the `issue_property_set` or `issue_property_deleted` webhooks. If this parameter is not present, the app is notified about all issue property updates.",
      "items": {
        "description": "A list of issue property keys. A change of those issue properties triggers the <code>issue_property_set</code> or <code>issue_property_deleted</code> webhooks. If this parameter is not present, the app is notified about all issue property updates.",
        "type": "string"
      },
      "type": "array"
    },
    "jqlFilter": {
      "description": "The JQL filter that specifies which issues the webhook is sent for. Only a subset of JQL can be used. The supported elements are:\n\n *  Fields: `issueKey`, `project`, `issuetype`, `status`, `assignee`, `reporter`, `issue.property`, and `cf[id]`. For custom fields (`cf[id]`), only the epic label custom field is supported.\".\n *  Operators: `=`, `!=`, `IN`, and `NOT IN`.",
      "type": "string"
    }
  },
  "required": [
    "events",
    "jqlFilter"
  ],
  "type": "object"
}