update_webhook_settings – Update webhook

Synopsis

Update webhook used by Endevor Bridge for Git.

Parameters

id (type: int)

ID of the webhook to update/delete.

context (type: str)

Git-Endevor mapping context (ID of the organization, project, team, or the Git repository owner).

mapping (type: str)

Git-Endevor mapping name (Git repository ID).

webhook_url (type: str)

Webhook URL.

name (type: str)

Webhook name.

enabled (type: bool, default: True)

Specifies if the webhook is active.

description (type: str)

Webhook description.

operation_types (type: list)

The webhook is triggered only for the specified operations - leave this param unspecified for all operations.

Choices:

  • BRIDGE_INITIATE

  • BRIDGE_START

  • BRIDGE_BENCHMARK

  • SYNC

  • MIGRATE_MAPPING

  • BRIDGE_HEARTBEAT

  • BRIDGE_STOP

  • DELETE_BRANCH

  • DELETE_MAPPING

  • GENERATE

  • INIT_REPOSITORY

  • REFRESH

  • UPDATE_REPOSITORY

operation_results (type: list)

The webhook is triggered only for the specified results of the operations - leave this param unspecified for all results.

Choices:

  • SUCCESS

  • FAILED

  • SKIPPED

  • SKIPPED_RETRY

  • WARNING

  • EXCEPTION

branches (type: list)

Enable the webhook only for specific branches of your mapping.

authorization_username (type: str)

Authorization username if your webhook requires authorization.

authorization_secret (type: str)

Authorization secret if your webhook requires authorization.

protocol (required, type: str)

Endevor Bridge for Git SCM protocol.

Default: https.

Choices:

  • http

  • https

host (required, type: str)

Endevor Bridge for Git hostname.

port (required, type: int)

Endevor Bridge for Git port.

user (required, type: str)

Endevor Bridge for Git username (your git username).

token (required, type: str)

Git personal access token (Obtain the token from your Git Enterprise Server).

reject_unauthorized (type: bool)

Reject self-signed certificates.

Default: false.

ebg_base_path (type: str)

The Endevor Bridge for Git Rest API base path.

password (type: str)

Password to authenticate to service on the mainframe.

cert_file (type: path)

The file path to a certificate file to use for authentication.

Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe

Docs.

cert_key_file (type: path)

The file path to a certificate key file to use for authentication.

Examples

- name: Update a global webhook with the properties to overwrite
  broadcom.endevor_bridge_for_git.update_webhook_settings:
    id: WEBHOOK-ID
    description: DESCRIPTION
    operation_types:
    - "SYNC"
    - "REFRESH"
    operation_results:
    - "SUCCESS"
    - "FAILED"

- name: Update a mapping webhook with the properties to overwrite
  broadcom.endevor_bridge_for_git.update_webhook_settings:
    id: WEBHOOK-ID
    context: MY-CONTEXT
    mapping: MY-MAPPING
    description: DESCRIPTION
    operation_types:
    - "SYNC"
    - "REFRESH"
    operation_results:
    - "SUCCESS"
    - "FAILED"

Return Values

data (type: list, when returned data is a dictionary)

Data from the module execution (a data structure). The items of this dict are set as individual return values on the top level as well.

error (type: complex, error)

More details about why the action has failed. If the failure is when calling an API service, the response contains the connection parameters.

additional_details (type: str)

Detailed message about the failure.

msg (type: str)

Short description of the result or failure.

request (type: str, API request failed)

HTTP method used to invoke API service request.

resource (type: str, API request failed)

URI of the resource of the API service request.

failed (type: bool, always)

A boolean that indicates if the task was failed or not.

list (type: list, when returned data is a list)

Data from the module execution (a list of data structures).

msg (type: str, sometimes)

Short description of the result or failure.

rc (type: int, always)

Exit code of the module, successful exit code is 0, failure is typically 1 or higher.

stderr (type: str, error)

Details of the error.

stdout (type: str, success)

Summary of the result.

Status

  • This module is maintained by Broadcom.