GitWebhook

GitWebhook
GitWebhook

Git Webhook details.

JSON Example 
{
    "_createTimeInMicros": 1568625938000000,
    "_createdBy": "exampleuser",
    "_link": "/codestream/api/<prefix>/8365ef3b-8bf3-48aa-bd5d-7113fcff827c",
    "_updateTimeInMicros": 1568625938000000,
    "_updatedBy": "exampleuser",
    "branchName": "master",
    "createdAt": "2019-09-16 09:25:38.065065+00",
    "createdBy": "exampleuser",
    "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",
    "id": "8365ef3b-8bf3-48aa-bd5d-7113fcff827c",
    "inclusions": [
        {
            "type": "PLAIN",
            "value": "example.txt"
        }
    ],
    "input": {
        "test": {
            "description": "test-value",
            "mandatory": false
        }
    },
    "name": "My-Name",
    "pipeline": "Git-Pipeline",
    "prioritizeExclusion": true,
    "project": "My-Project",
    "refreshToken": "I5FLA8iQhlZwoos6OL3goKciAF5e",
    "repoName": "codestream",
    "secretToken": "DSkUyJJ8KA8rOSk=Ci",
    "serverType": "GITHUB/GITLAB/BITBUCKET",
    "serverWebhookId": 192837465,
    "updatedAt": "2019-09-16 09:25:38.065065+00",
    "updatedBy": "exampleuser",
    "version": "v1"
}
integer As int64 As int64
_createTimeInMicros
Optional

This field is provided for backward compatibility. Contains the same value as the 'createdAt' field as a UNIX timestamp in microseconds

string
_createdBy
Optional

This field is provided for backward compatibility. Contains the same value as the 'createdBy' field

string
_link
Optional

Partial URL that provides details of the resource.

integer As int64 As int64
_updateTimeInMicros
Optional

This field is provided for backward compatibility. Contains the same value as the 'updatedAt' field as a UNIX timestamp in microseconds

string
_updatedBy
Optional

This field is provided for backward compatibility. Contains the same value as the 'updatedBy' field

string
branchName
Optional

Branch name for which the webhook has been configured.

string
createdAt
Optional

Date when the entity was created. The date is in ISO 8601 with time zone

string
createdBy
Optional

The user that created this entity

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.

string
id
Optional

The id of this resource.

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.

string
updatedAt
Optional

Date when the entity was last updated. The date is in ISO 8601 with time zone.

string
updatedBy
Optional

The user that last updated this entity

string
version
Optional

Version of the resource.

Returned By