Atlassian · Schema

Webhook

A webhook.

CodeCollaborationPlatformProductivitySoftware Development

Properties

Name Type Description
events array The Jira events that trigger the webhook.
expirationDate integer The date after which the webhook is no longer sent. Use [Extend webhook life](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-webhooks/#api-rest-api-3-webhook-refresh-put) to ext
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.
id integer The ID of the webhook.
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.
View JSON Schema on GitHub

JSON Schema

atlassian-webhook-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/Webhook",
  "title": "Webhook",
  "additionalProperties": false,
  "description": "A webhook.",
  "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"
    },
    "expirationDate": {
      "description": "The date after which the webhook is no longer sent. Use [Extend webhook life](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-webhooks/#api-rest-api-3-webhook-refresh-put) to extend the date.",
      "format": "int64",
      "readOnly": true,
      "type": "integer"
    },
    "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"
    },
    "id": {
      "description": "The ID of the webhook.",
      "format": "int64",
      "type": "integer"
    },
    "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.",
      "type": "string"
    }
  },
  "required": [
    "events",
    "id",
    "jqlFilter"
  ],
  "type": "object"
}

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/atlassian-webhook"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.