jira.js
    Preparing search index...

    Function createWebhook

    • Registers a webhook. Requires administrator permission.

      Parameters

      • client: Client
      • parameters: {
            configuration?: Record<string, any>;
            events?: string[];
            excludeBody?: boolean;
            filters?: Record<string, any>;
            name: string;
            sslVerificationRequired?: boolean;
            url: string;
        }
        • Optionalconfiguration?: Record<string, any>
        • Optionalevents?: string[]

          The events to deliver, e.g. jira:issue_created.

        • OptionalexcludeBody?: boolean

          Deliver the event without its body.

        • Optionalfilters?: Record<string, any>

          Narrows what is delivered, e.g. { "issue-related-events-section": jql }.

        • name: string
        • OptionalsslVerificationRequired?: boolean
        • url: string

          Where Jira posts the event.

      • Optionaloptions: RequestOptions

      Returns Promise<
          {
              active?: boolean;
              configuration?: Record<string, any>;
              createdDate?: number;
              events?: string[];
              id: number;
              name: string;
              scopeType?: string;
              sslVerificationRequired?: boolean;
              statistics?: {
                  counts?: {
                      errors?: number;
                      failures?: number;
                      successes?: number;
                      window?: { duration?: number; start?: number; [key: string]: unknown };
                      [key: string]: unknown;
                  };
                  lastError?: Record<string, any>;
                  [key: string]: unknown;
              };
              updatedDate?: number;
              url: string;
              [key: string]: unknown;
          },
      >

    Settings
    Member Visibility