Skip to content

Type Alias: WebhookPayload ​

ts
type WebhookPayload = 
  | IssueWebhookPayload
  | IssuePropertyWebhookPayload
  | WorklogWebhookPayload
  | CommentWebhookPayload
  | AttachmentWebhookPayload
  | IssueLinkWebhookPayload
  | IssueTypeWebhookPayload
  | ProjectWebhookPayload
  | VersionWebhookPayload
  | FilterWebhookPayload
  | UserWebhookPayload
  | OptionWebhookPayload
  | SprintWebhookPayload
  | BoardWebhookPayload
  | AppAccessWebhookPayload
  | JiraExpressionWebhookPayload;

Defined in: src/webhooks/payloads.ts:206

Every payload above, discriminated by webhookEvent.

ts
import type { WebhookPayload } from 'jira.js/webhooks';

function handle(payload: WebhookPayload) {
  switch (payload.webhookEvent) {
    case 'jira:issue_created':
      return payload.issue.key;
    case 'sprint_started':
      return payload.sprint?.name;
  }
}