Skip to content

Support Jira Webhook

Operations Summary

Method Endpoint Description
POST /api/support-jira-webhook/ Webhook

Webhook

1
2
3
4
5
6
http \
  POST \
  https://api.example.com/api/support-jira-webhook/ \
  Authorization:"Token YOUR_API_TOKEN" \
  webhookEvent="string-value" \
  issue:='{}'

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.web_hook_receiver_request import WebHookReceiverRequest # (1)
from waldur_api_client.api.support_jira_webhook import support_jira_webhook # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = WebHookReceiverRequest(
    webhookEvent="string-value",
    issue={}
)
response = support_jira_webhook.sync(
    client=client,
    body=body_data
)

print(response)
  1. Model Source: WebHookReceiverRequest
  2. API Source: support_jira_webhook
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
import { supportJiraWebhook } from 'waldur-js-client';

try {
  const response = await supportJiraWebhook({
  auth: "Token YOUR_API_TOKEN",
  body: {
    "webhookEvent": "string-value",
    "issue": {}
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Field Type Required Description
webhookEvent string ✓
issue object ✓
issue.key string ✓ Jira issue key
issue.fields object ✓
issue.fields.project object ✓
issue.fields.project.id string ✓ Jira field ID
issue.fields.project.name string ✓ Jira field name
issue.fields.project.key string ✓ Jira project key
issue.fields.comment object (free-form)
comment object
comment.id string ✓ Jira comment ID
changelog object
changelog.items array of anys ✓ List of changelog items
issue_event_type_name string

200 -

Field Type Description
webhookEvent string
issue object
issue.key string Jira issue key
issue.fields object
issue.fields.project object
issue.fields.project.id string Jira field ID
issue.fields.project.name string Jira field name
issue.fields.project.key string Jira project key
issue.fields.comment object (free-form)
comment object
comment.id string Jira comment ID
changelog object
changelog.items array of anys List of changelog items
issue_event_type_name string