DockerRegistryWebHookSpec

DockerRegistryWebHookSpec
DockerRegistryWebHookSpec

Docker Registry Webhook specification.

JSON Example
{
    "description": "It is a docker saas webhook",
    "enabled": true,
    "endpoint": "Dcocker-SaaS",
    "externalListenerLink": "/codestream/api/registry-webhook-listeners/412aa461-6d46-47d6-af93-152bb0d88682",
    "imageNameRegExPattern": "admin/wordpress",
    "input": {
        "test": {
            "description": "test-value",
            "mandatory": false
        }
    },
    "name": "My-Name",
    "pipeline": "CD-Pipeline",
    "project": "My-Project",
    "refreshToken": "I5FLA8iQhlZwoos6OL3goKciAF5e",
    "repoName": "codestream",
    "secretToken": "DSkUyJJ8KA8rOSk=Ci",
    "serverType": "DockerHub/Docker_Trusted_Registry",
    "slug": "docker-webhook",
    "tagNamePattern": "tag1"
}
string
description
Optional

Docker webhook description.

boolean
enabled
Optional

Indicates whether Docker webhook is enabled or not.

string
endpoint
Optional

Docker endpoint.

string
externalListenerLink
Optional

Docker webhook listener link.

string
imageNameRegExPattern
Optional

If provided then the pipeline execution is triggered only when the given image name regex matches the image name in the received payload.

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 docker event occur.

string
project
Optional

The project this entity belongs to.

string
refreshToken
Optional

Codestream API token.

string
repoName
Optional

Docker Repo Name.

string
secretToken
Optional

Secret token to validate received payloads.

string
serverType
Optional

Docker server type.

string
slug
Optional

Docker webhook name.

string
tagNamePattern
Optional

If provided then the pipeline execution is triggered only when the given tag name regex matches the tag name(s) in the received payload.