GitWebhookSpec

GitWebhookSpec
GitWebhookSpec

Git Webhook specification.

JSON Example 
{
    "branchName": "master",
    "delayTimeInMins": 2,
    "description": "string",
    "endpoint": "GitHub-SaaS",
    "eventCategory": "PUSH",
    "exclusions": [
        {
            "type": "PLAIN",
            "value": "example.txt"
        }
    ],
    "externalListenerLink": "codestream/api/git-webhook-listeners/173f5ed5-2197-4975-b782-a8679b2e4cd3",
    "inclusions": [
        {
            "type": "PLAIN",
            "value": "example.txt"
        }
    ],
    "input": {
        "test": {
            "description": "test-value",
            "mandatory": false
        }
    },
    "name": "My-Name",
    "pipeline": "CICD-Pipeline",
    "prioritizeExclusion": true,
    "project": "My-Project",
    "refreshToken": "I5FLA8iQhlZwoos6OL3goKciAF5e",
    "repoName": "Codestream",
    "secretToken": "DSkUyJJ8KA8rOSk=Ci",
    "serverType": "GITHUB/GITLAB/BITBUCKET",
    "serverWebhookId": "serverWebhookId\": \"12678345"
}
string
branchName
Optional

Branch name for which the webhook has been configured.

integer As int32 As int32
delayTimeInMins
Optional

Delay time after which the pipeline execution is triggered.

string
description
Required

A human-friendly description.

string
endpoint
Optional

Git endpoint.

string
eventCategory
Optional

Git event type.

array of GitWebhook_FileFilter
exclusions
Optional

Provide file exclusions as conditions for the trigger.

string
externalListenerLink
Optional

Git webhook listener link.

array of GitWebhook_FileFilter
inclusions
Optional

Provide file inclusions as conditions for the trigger.

object
input
Optional

Pipeline Execution input properties.

string
name
Required

A human-friendly name used as an identifier in APIs that support this option

string
pipeline
Optional

Pipeline name which is meant to be triggered when a git event occur.

boolean
prioritizeExclusion
Optional

Prioritize Exclusion ensures that pipelines are not triggered even if any ” + “of the files in a commit match the specified files in the exclusion paths or regex.

string
project
Optional

The project this entity belongs to.

string
refreshToken
Optional

Codestream API token.

string
repoName
Optional

Repo name for which the webhook has been configured.

string
secretToken
Optional

Secret token to validate received payloads.

string
serverType
Optional

Git Server Type.

string
serverWebhookId
Optional

Git webhook id.

Parameter To