CoderHelm Docs
APIWebhooks

Jira webhook

POST
/webhooks/jira/{token}

For a plain Jira webhook, when the CoderHelm Jira app can't be installed. The URL holds a token generated for your team on the Jira page of the dashboard. If you also generated a secret there, every request must carry X-Hub-Signature: sha256= and the hex HMAC-SHA256 of the raw body, keyed with that secret. Jira Cloud signs webhooks this way when you set the secret on the webhook; a Jira automation can send the header itself.

Authorization

jira_signature
headerX-Hub-Signature<token>

Only when the team generated a webhook secret: sha256= and the hex HMAC-SHA256 of the raw body, keyed with that secret.

Path Parameters

token*string

The webhook token from the Jira page of the dashboard.

Request Body

The Jira event.

application/json
  1. body

The body of a Jira webhook, as Jira sends it. Only the fields CoderHelm reads are listed; the rest are accepted and ignored.

Example
{  "coderhelm": {    "repo_name": "web",    "repo_owner": "acme"  },  "issue": {    "fields": {      "labels": [        "coderhelm"      ],      "summary": "Add rate limiting to the login form"    },    "key": "WEB-42"  },  "webhookEvent": "jira:issue_updated"}
coderhelm?null|
comment?null|
issue*

The issue. A run starts when it has the label coderhelm (or one starting coderhelm:), or is assigned to a user whose name contains "CoderHelm", in a project the team switched on.

webhookEvent*string

The event, such as jira:issue_created, jira:issue_updated or comment_created. An event whose name contains comment retries a failed run or sends feedback to an open pull request; other issue events can start a run.

Example"jira:issue_updated"

Response Body

Accepted (whether or not it started anything).

curl -X POST 'https://api.coderhelm.com/webhooks/jira/string' \  -H 'Content-Type: application/json' \  -d '{  "coderhelm": {    "repo_name": "web",    "repo_owner": "acme"  },  "issue": {    "fields": {      "labels": [        "coderhelm"      ],      "summary": "Add rate limiting to the login form"    },    "key": "WEB-42"  },  "webhookEvent": "jira:issue_updated"}'
Empty
Edit on GitHub