Atlassian · Example Payload

Atlassian Atlassianregisterdynamicwebhooks Example

CodeCollaborationPlatformProductivitySoftware Development

Atlassian Atlassianregisterdynamicwebhooks Example is an example object payload from Atlassian, with 6 top-level fields. It illustrates the shape of data this provider's APIs accept or return.

Top-level fields

operationIdmethodpathsummaryrequestExamplesresponseExamples

Example Payload

Raw ↑ 
{
  "operationId": "atlassianRegisterdynamicwebhooks",
  "method": "POST",
  "path": "/rest/api/3/webhook",
  "summary": "Atlassian Register Dynamic Webhooks",
  "requestExamples": [
    {
      "contentType": "application/json",
      "example": {
        "url": "https://your-app.example.com/webhook-received",
        "webhooks": [
          {
            "events": [
              "jira:issue_created",
              "jira:issue_updated"
            ],
            "fieldIdsFilter": [
              "summary",
              "customfield_10029"
            ],
            "jqlFilter": "project = PROJ"
          },
          {
            "events": [
              "jira:issue_deleted"
            ],
            "jqlFilter": "project IN (PROJ, EXP) AND status = done"
          },
          {
            "events": [
              "issue_property_set"
            ],
            "issuePropertyKeysFilter": [
              "my-issue-property-key"
            ],
            "jqlFilter": "project = PROJ"
          }
        ]
      }
    }
  ],
  "responseExamples": [
    {
      "status": "200",
      "contentType": "application/json",
      "example": "{\"webhookRegistrationResult\":[{\"createdWebhookId\":1000},{\"errors\":[\"The clause watchCount is unsupported\"]},{\"createdWebhookId\":1001}]}"
    }
  ]
}