Update Using PUT 1
Update a Git Webhook
id
The version of the API in yyyy-MM-dd format (UTC). For versioning information please refer to /codestream/api/about
{
"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"
}Branch name for which the webhook has been configured.
Delay time after which the pipeline execution is triggered.
A human-friendly description.
Git endpoint.
Git event type.
Provide file exclusions as conditions for the trigger.
Git webhook listener link.
Provide file inclusions as conditions for the trigger.
Pipeline Execution input properties.
A human-friendly name used as an identifier in APIs that support this option
Pipeline name which is meant to be triggered when a git event occur.
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.
The project this entity belongs to.
Codestream API token.
Repo name for which the webhook has been configured.
Secret token to validate received payloads.
Git Server Type.
Git webhook id.
'Success' with Git Webhook Update
{
"_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"
}This field is provided for backward compatibility. Contains the same value as the 'createdAt' field as a UNIX timestamp in microseconds
This field is provided for backward compatibility. Contains the same value as the 'createdBy' field
Partial URL that provides details of the resource.
This field is provided for backward compatibility. Contains the same value as the 'updatedAt' field as a UNIX timestamp in microseconds
This field is provided for backward compatibility. Contains the same value as the 'updatedBy' field
Branch name for which the webhook has been configured.
Date when the entity was created. The date is in ISO 8601 with time zone
The user that created this entity
Delay time after which the Pipeline Execution is triggered.
A human-friendly description.
Git endpoint.
Git event type.
Provide file exclusions as conditions for the trigger.
Git webhook listener link.
The id of this resource.
Provide file inclusions as conditions for the trigger.
Pipeline Execution input properties.
A human-friendly name used as an identifier in APIs that support this option
Pipeline name which is meant to be triggered when a git event occur.
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.
The project this entity belongs to.
Codestream API token.
Repo name for which the webhook has been configured.
Secret token to validate received payloads.
Git Server Type.
Git webhook id.
Date when the entity was last updated. The date is in ISO 8601 with time zone.
The user that last updated this entity
Version of the resource.
Unauthorized Request
Forbidden
Not Found
Server Error