jira.js
    Preparing search index...

    Function registerDynamicWebhooks

    • Registers webhooks.

      NOTE: for non-public OAuth apps, webhooks are delivered only if there is a match between the app owner and the user who registered a dynamic webhook.

      Permissions required: Only Connect and OAuth 2.0 apps can use this operation.

      Parameters

      • client: Client
      • parameters: {
            url: string;
            webhooks: {
                events: (
                    | string & {}
                    | "jira:issue_created"
                    | "jira:issue_updated"
                    | "jira:issue_deleted"
                    | "comment_created"
                    | "comment_updated"
                    | "comment_deleted"
                    | "issue_property_set"
                    | "issue_property_deleted"
                    | "sprint_created"
                    | "sprint_updated"
                    | "sprint_closed"
                    | "sprint_deleted"
                    | "sprint_started"
                    | "jira:version_released"
                    | "jira:version_unreleased"
                    | "jira:version_created"
                    | "jira:version_moved"
                    | "jira:version_updated"
                    | "jira:version_merged"
                    | "jira:version_deleted"
                )[];
                fieldIdsFilter?: string[];
                issuePropertyKeysFilter?: string[];
                jqlFilter: string;
                [key: string]: unknown;
            }[];
        }
        • url: string

          The URL that specifies where to send the webhooks. This URL must use the same base URL as the Connect app. Only a single URL per app is allowed to be registered.

        • webhooks: {
              events: (
                  | string & {}
                  | "jira:issue_created"
                  | "jira:issue_updated"
                  | "jira:issue_deleted"
                  | "comment_created"
                  | "comment_updated"
                  | "comment_deleted"
                  | "issue_property_set"
                  | "issue_property_deleted"
                  | "sprint_created"
                  | "sprint_updated"
                  | "sprint_closed"
                  | "sprint_deleted"
                  | "sprint_started"
                  | "jira:version_released"
                  | "jira:version_unreleased"
                  | "jira:version_created"
                  | "jira:version_moved"
                  | "jira:version_updated"
                  | "jira:version_merged"
                  | "jira:version_deleted"
              )[];
              fieldIdsFilter?: string[];
              issuePropertyKeysFilter?: string[];
              jqlFilter: string;
              [key: string]: unknown;
          }[]

          A list of webhooks.

      • Optionaloptions: RequestOptions

      Returns Promise<
          {
              webhookRegistrationResult?: {
                  createdWebhookId?: number;
                  errors?: string[];
                  [key: string]: unknown;
              }[];
              [key: string]: unknown;
          },
      >

    Settings
    Member Visibility