Fix Webhook creation.

[dominicgunn]

Changes

Attempting to create webhooks fail unless a name is specified. As per the documentation the only name that is valid is "web", so I haven't opted to allow modification of this but creation seems to fail without it.

This seems to impact only Github Enterprise.

[googlebot]

Thanks for your pull request. It looks like this may be your first contribution to a Google open source project (if not, look below for help). Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA).

📝 Please visit https://cla.developers.google.com/ to sign.

Once you've signed (or fixed any issues), please reply here (e.g. I signed it!) and we'll verify it.

---

What to do if you already signed the CLA

Individual signers

• It's possible we don't have your GitHub username or you're using a different email address on your commit. Check your existing CLA data and verify that your email is set on your git commits.

Corporate signers

• Your company has a Point of Contact who decides which employees are authorized to participate. Ask your POC to be added to the group of authorized contributors. If you don't know who your Point of Contact is, direct the Google project maintainer to go/cla#troubleshoot (Public version).
• The email used to register you as an authorized contributor must be the email used for the Git commit. Check your existing CLA data and verify that your email is set on your git commits.
• The email used to register you as an authorized contributor must also be attached to your GitHub account.

[dominicgunn]

I signed it!

[googlebot]

CLAs look good, thanks!

[gmlewis]

The only documentation I found about this:
https://developer.github.com/v3/repos/hooks/#create-a-hook
says that the name field has a default value of web.

Do you want to contact GitHub ([email protected]) and ask them to clarify what is going on after describing the situation you discovered? I have found their support team to be incredibly responsive and helpful.

[radeksimko]

I have just emailed GitHub support about this, will update here once I get response from them.

[radeksimko]

Here's a response I received from a helpful GitHub support folk:

---

This field is currently a legacy field, in that we only provide a single option for this: 'web' for webhooks. Previously we had the concept of GitHub Services: https://developer.github.com/changes/2018-10-01-denying-new-github-services/ that allowed you to create hooks for this.

However as mentioned in the above article we have since deprecated and switched off this service. We decided to leave this field in, to prevent issues with current integrations that might still rely on this. In this case it automatically defaults to 'web' if omitted, or if provided, must have the value 'web'.

For instance the following core curl request works:

curl -H "Accept: application/vnd.github.v3+json" \
-H "Authorization: token $TOKEN" \
-d "{\"config\":{\"url\":\"$URL\"}}" \
https://github.com/api/repos/mattamorphic/WebhookTest/hooks

Where $TOKEN is the OAuth token, and $URL is the resource to send the requests to.

Long term we could choose to add other values to this as we are often iterating on the services that we provide, we could also choose to in the long term officially deprecate and remove this field as part of an ongoing effort to improve our validation rules.

In terms of the PR, #1117, the author @dominicgunn mentions that:

Attempting to create webhooks fail unless a name is specified

As we haven't been able to reproduce this with the above curl I'd be interested to know if the user can reproduce this with a curl -v?

TL;DR; This field has a single value, is a legacy field, and has a default value if omitted.

In terms of defining this field in the SDK, I feel like the SDK should emulate the API behaviour:

1. Optional, and if not provided default to 'web'
2. If provided this can only accept 'web'

---

I'm not sure if the SDK has any convention around validation of arguments, which may need to be added.

[gmlewis]

Thank you, @dominicgunn, and thank you, @radeksimko for contacting GitHub support and reporting back!

I have just one minor tweak, and then we can merge after we get a second LGTM.

[gmlewis]

Note that this PR does not implement the recommendation in the above comment but it sounds to me like the API is not changing, so this solution would solve the issue and is fine with me.

We'll see if @gauntface agrees.

[dominicgunn]

For some deeper clarity, this is against a enterprise version of Github (GHE), I'm not sure how much difference that would make.

In terms of allowing this to be definable by the user, I'm not against it but it feels superfluous given that the only accepted value will be "web".

Thanks @radeksimko for reaching out to Github support, I'm sorry I haven't been more involved in the discussion here.

[gauntface]

I'm ok with this landing, but it does sound like a bug in GHE if you are getting an error without the name field.

[radeksimko]

In terms of allowing this to be definable by the user, I'm not against it but it feels superfluous given that the only accepted value will be "web".

Having it definable would help us a lot in the Terraform GitHub provider as we still haven't upgraded SDK since this field was removed and if the field is put back we can deprecate it more gracefully and easily, rather than just pulling the cord and forcing everyone to change their configurations.

Also we might actually not deprecate it at all as there might be some plans in the future around that field as the GitHub Support folk mentioned.

I'm willing to PR that change separately though.

[sourabh3b]

Hi All,
Adding my thoughts to the conversation.
I am facing the same issue.
Getting this error, while adding a webhook to a repo using go-github client : "name" wasn't supplied. []
It's due to the field "name" in POST /repos/:owner/:repo/hooks API. The documentation at https://developer.github.com/v3/repos/hooks/#create-a-hook says that name is not required, whereas enterprise documentation at https://developer.github.com/enterprise/2.14/v3/repos/hooks/#create-a-hook says that both name and config are required. Hence I am able to add webhook using Postman but not using go-github client.

[gmlewis]

Thank you, everyone, for your comments. This should help GitHub Enterprise users.
LGTM.
Merging.