Method: Gitlab::Client::Projects#add_project_hook

Defined in:
lib/gitlab/client/projects.rb

#add_project_hook(project, url, options = {}) ⇒ Gitlab::ObjectifiedHash

Adds a new hook to the project.

Examples:

Gitlab.add_project_hook(42, 'https://api.example.net/v1/webhooks/ci')

Parameters:

  • project (Integer, String) —

    The ID or path of a project.

  • url (String) —

    The hook URL.

  • options (Hash) (defaults to: {}) —

    A customizable set of options.

  • option (Boolean) —

    :push_events Trigger hook on push events (0 = false, 1 = true)

  • option (Boolean) —

    :issues_events Trigger hook on issues events (0 = false, 1 = true)

  • option (Boolean) —

    :merge_requests_events Trigger hook on merge_requests events (0 = false, 1 = true)

  • option (Boolean) —

    :tag_push_events Trigger hook on push_tag events (0 = false, 1 = true)

Returns:



224
225
226
227
 
# File 'lib/gitlab/client/projects.rb', line 224

def add_project_hook(project, url, options = {})
  body = { url: url }.merge(options)
  post("/projects/#{url_encode project}/hooks", body: body)
end