receive method

Future<Empty> receive(HttpBody request, { String? webhookKey, String? $fields, })

ReceiveGitHubDotComWebhook is called when the API receives a github.com webhook.

request - The metadata request object.

Request parameters:

webhookKey - For GitHub Enterprise webhooks, this key is used to associate the webhook request with the GitHubEnterpriseConfig to use for validation.

$fields - Selector specifying which fields to include in a partial response.

Completes with a Empty.

Completes with a commons.ApiRequestError if the API endpoint returned an error.

If the used http.Client completes with an error when making a REST call, this method will complete with the same error.

Implementation

async.Future<Empty> receive(
  HttpBody request, {
  core.String? webhookKey,
  core.String? $fields,
}) async {
  final body_ = convert.json.encode(request);
  final queryParams_ = <core.String, core.List<core.String>>{
    if (webhookKey != null) 'webhookKey': [webhookKey],
    if ($fields != null) 'fields': [$fields],
  };

  const url_ = 'v1/githubDotComWebhook:receive';

  final response_ = await _requester.request(
    url_,
    'POST',
    body: body_,
    queryParams: queryParams_,
  );
  return Empty.fromJson(response_ as core.Map<core.String, core.dynamic>);
}