OpenAPI/Swagger spec for Jira webhooks

Jira Development Jira Cloud
, , , , , ,
1

Hello,

I’m building an AWS Lambda function to consume a Jira webhook. The webhook will be triggered when a certain state change happens on Bugs. As a security measure, I plan to use AWS API Gateway as a proxy for the lambda function endpoint.

In order to implement a REST API Gateway, our standard deployment process requires the API specification in OpenAPI or Swagger format. Does such a specification exist for Jira webhooks?

I was able to find a Swagger document for the Jira REST API (https://developer.atlassian.com/cloud/jira/platform/swagger.v3.json) but wasn’t sure if the same document can be used for consuming webhooks as well.

Thanks,
PK

2

@PK1 no, such a specification does not exist, because we can’t create it for you. You should create your own OpenAPI spec, with a single POST operation for the path you choose.

The optional webhook event payload has some limited documentation in the section Webhooks: Executing a webhook.

1 Like