Skip to content

Example for 'ms.vss-servicehooks.consumers' Contribution #189

@SCsnwbrdr

Description

@SCsnwbrdr

I was looking through older documentation, and I was trying to find more complete documentation around how to create a "ms.vss-servicehooks.consumer" contribution type. There isn't one in this repo yet (there is in the old repo).

Also, the schema references I have found online don't look complete, as the "publishEvent" object only has "URL" listed as the only property. Could we get expanded properties that are allowed on the "publishEvent". Would love to include additional headers if possible.

Old code, with minor changes, is below for reference.

"contributions": [
        {
            "id": "consumersample",
            "type": "ms.vss-servicehooks.consumer",
            "targets": [
                "ms.vss-servicehooks.consumers"
            ],
            "properties": {
                "id": "consumersample",
                "name": "Sample Consumer",
                "description": "Sample consumer service",
                "informationUrl": "https://aka.ms/vsoextensions",
                "inputDescriptors": [
                    {
                        "id": "url",
                        "isRequired": true,
                        "name": "URL",
                        "description": "URL to post event payload to",
                        "inputMode": "textBox"
                    },
                    {
                        "id": "secret",
                        "isRequired": true,
                        "name": "Secret",
                        "description": "Secret key for authentication",
                        "isConfidential": true,
                        "inputMode": "passwordBox"
                    }
                ],
                "actions": [
                    {
                        "id": "performAction",
                        "name": "Perform action",
                        "description": "Posts a standard event payload",
                        "supportedEventTypes": [
                            "git.push",
                            "git.pullrequest.created",
                            "git.pullrequest.updated"
                        ],
                        "publishEvent": {
                            "url": "{{{url}}}?key={{{secret}}}",
                            "resourceDetailsToSend": "all",
                            "messagesToSend": "all",
                            "detailedMessagesToSend": "all"
                        }
                    }
                ]
            }
        }
    ]

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions