zowe › endevor-bridge-for-git › create › webhook-settings🖨️

Create webhook used by Endevor Bridge for Git.

Usage

zowe endevor-bridge-for-git create webhook-settings [context] [mapping] [options]

Positional Arguments

• context (string)

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

• mapping (string)

  • Git-Endevor mapping name (Git repository ID).

Options

• --webhook-url | --url (string)

  • Webhook URL.

• --name (string)

  • Webhook name.

• --description (string)

  • Webhook description.

• --operation-types | --operations (array)

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

    Allowed values: 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 (array)

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

    Allowed values: SUCCESS, FAILED, SKIPPED, SKIPPED_RETRY, WARNING, EXCEPTION

• --branches | --br (array)

  • Enable the webhook only for specific branches of your mapping.

• --authorization-username | --auth-name (string)

  • Authorization username if your webhook requires authorization.

• --authorization-secret | --auth-secret (string)

  • Authorization secret if your webhook requires authorization.

Endevor Bridge for Git connection options (you can also use an 'ebg' profile)

• --protocol | --prot (string)

  • Endevor Bridge for Git SCM protocol.

    Default: https

    Default value: https
    Allowed values: http, https

• --host | -H (string)

  • Endevor Bridge for Git hostname.

• --port | -P (number)

  • Endevor Bridge for Git port.

• --user | -u (string)

  • Endevor Bridge for Git username (your git username).

• --token | -t (string)

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

• --reject-unauthorized | --ru (boolean)

  • Reject self-signed certificates.

    Default: false

• --ebg-base-path (string)

  • The Endevor Bridge for Git Rest API base path.

Profile Options

• --ebg-profile | --ebg-p (string)

  • The name of a (ebg) profile to load for this command execution.

• --base-profile | --base-p (string)

  • The name of a (base) profile to load for this command execution.

Base Connection Options

• --password | --pass | --pw (string)

  • Password to authenticate to service on the mainframe.

• --token-type | --tt (string)

  • The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.

• --token-value | --tv (string)

  • The value of the token to pass to the API.

• --cert-file (local file 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 (local file path)

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

Examples

• Create global webhook that captures successful and failed sync and refresh oprations:

  • zowe endevor-bridge-for-git create webhook-settings --url URL --name NAME --description DESCRIPTION --operation-types SYNC REFRESH --operation-results SUCCESS FAILED Copy

• Create mapping webhook that captures successful and failed sync and refresh oprations:

  • zowe endevor-bridge-for-git create webhook-settings MY-CONTEXT MY-MAPPING --url URL --name NAME --description DESCRIPTION --operation-types SYNC REFRESH --operation-results SUCCESS FAILED Copy