Atlassian The Jira Cloud platform REST API — Webhooks

naftiko: 1.0.0-alpha2
info:
  label: Atlassian The Jira Cloud platform REST API — Webhooks
  description: 'Atlassian The Jira Cloud platform REST API — Webhooks. 5 operations. Lead operation: Atlassian Delete Webhooks
    By Id. Self-contained Naftiko capability covering one Atlassian business surface.'
  tags:
  - Atlassian
  - Webhooks
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    ATLASSIAN_API_KEY: ATLASSIAN_API_KEY
capability:
  consumes:
  - type: http
    namespace: jira-webhooks
    baseUri: https://your-domain.atlassian.net
    description: Atlassian The Jira Cloud platform REST API — Webhooks business capability. Self-contained, no shared references.
    resources:
    - name: rest-api-3-webhook
      path: /rest/api/3/webhook
      operations:
      - name: atlassiandeletewebhookbyid
        method: DELETE
        description: Atlassian Delete Webhooks By Id
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: atlassiangetdynamicwebhooksforapp
        method: GET
        description: Atlassian Get Dynamic Webhooks For App
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: startAt
          in: query
          type: integer
          description: The index of the first item to return in a page of results (page offset).
        - name: maxResults
          in: query
          type: integer
          description: The maximum number of items to return per page.
      - name: atlassianregisterdynamicwebhooks
        method: POST
        description: Atlassian Register Dynamic Webhooks
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: rest-api-3-webhook-failed
      path: /rest/api/3/webhook/failed
      operations:
      - name: atlassiangetfailedwebhooks
        method: GET
        description: Atlassian Get Failed Webhooks
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: maxResults
          in: query
          type: integer
          description: The maximum number of webhooks to return per page. If obeying the maxResults directive would result
            in records with the same failure time being split across pag
        - name: after
          in: query
          type: integer
          description: The time after which any webhook failure must have occurred for the record to be returned, expressed
            as milliseconds since the UNIX epoch.
    - name: rest-api-3-webhook-refresh
      path: /rest/api/3/webhook/refresh
      operations:
      - name: atlassianrefreshwebhooks
        method: PUT
        description: Atlassian Extend Webhook Life
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    authentication:
      type: bearer
      token: '{{env.ATLASSIAN_API_KEY}}'
  exposes:
  - type: rest
    namespace: jira-webhooks-rest
    port: 8080
    description: REST adapter for Atlassian The Jira Cloud platform REST API — Webhooks. One Spectral-compliant resource per
      consumed operation, prefixed with /v1.
    resources:
    - path: /v1/api/3/webhook
      name: rest-api-3-webhook
      description: REST surface for rest-api-3-webhook.
      operations:
      - method: DELETE
        name: atlassiandeletewebhookbyid
        description: Atlassian Delete Webhooks By Id
        call: jira-webhooks.atlassiandeletewebhookbyid
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: GET
        name: atlassiangetdynamicwebhooksforapp
        description: Atlassian Get Dynamic Webhooks For App
        call: jira-webhooks.atlassiangetdynamicwebhooksforapp
        with:
          startAt: rest.startAt
          maxResults: rest.maxResults
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: atlassianregisterdynamicwebhooks
        description: Atlassian Register Dynamic Webhooks
        call: jira-webhooks.atlassianregisterdynamicwebhooks
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/3/webhook/failed
      name: rest-api-3-webhook-failed
      description: REST surface for rest-api-3-webhook-failed.
      operations:
      - method: GET
        name: atlassiangetfailedwebhooks
        description: Atlassian Get Failed Webhooks
        call: jira-webhooks.atlassiangetfailedwebhooks
        with:
          maxResults: rest.maxResults
          after: rest.after
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/3/webhook/refresh
      name: rest-api-3-webhook-refresh
      description: REST surface for rest-api-3-webhook-refresh.
      operations:
      - method: PUT
        name: atlassianrefreshwebhooks
        description: Atlassian Extend Webhook Life
        call: jira-webhooks.atlassianrefreshwebhooks
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: jira-webhooks-mcp
    port: 9090
    transport: http
    description: MCP adapter for Atlassian The Jira Cloud platform REST API — Webhooks. One tool per consumed operation, routed
      inline through this capability's consumes block.
    tools:
    - name: atlassian-delete-webhooks-id
      description: Atlassian Delete Webhooks By Id
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: jira-webhooks.atlassiandeletewebhookbyid
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: atlassian-get-dynamic-webhooks-app
      description: Atlassian Get Dynamic Webhooks For App
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: jira-webhooks.atlassiangetdynamicwebhooksforapp
      with:
        startAt: tools.startAt
        maxResults: tools.maxResults
      outputParameters:
      - type: object
        mapping: $.
    - name: atlassian-register-dynamic-webhooks
      description: Atlassian Register Dynamic Webhooks
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: jira-webhooks.atlassianregisterdynamicwebhooks
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: atlassian-get-failed-webhooks
      description: Atlassian Get Failed Webhooks
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: jira-webhooks.atlassiangetfailedwebhooks
      with:
        maxResults: tools.maxResults
        after: tools.after
      outputParameters:
      - type: object
        mapping: $.
    - name: atlassian-extend-webhook-life
      description: Atlassian Extend Webhook Life
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: jira-webhooks.atlassianrefreshwebhooks
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.