### Home Classes Methods

### In Files

- lib/github_api/repos/hooks.rb

### Parent

Github::API

### Methods

- #all
- #create
- #delete
- #edit
- #find
- #get
- #list
- #test

### Class/Module Index

Quicksearch

- Github
- Github::API
- Github::Activity
- Github::Activity::Events
- Github::Activity::Notifications
- Github::Activity::Starring
- Github::Activity::Watching
- Github::ApiFactory
- Github::Arguments
- Github::Authorization
- Github::Authorizations
- Github::AutoloadHelper
- Github::Client
- Github::Configuration
- Github::Connection
- Github::Constants
- Github::CoreExt
- Github::CoreExt::OrderedHash
- Github::Descendants
- Github::Emojis
- Github::Error
- Github::Error::BadRequest
- Github::Error::ClientError
- Github::Error::Forbidden
- Github::Error::GithubError
- Github::Error::InternalServerError
- Github::Error::InvalidOptions
- Github::Error::NotAcceptable
- Github::Error::NotFound
- Github::Error::RequiredParams
- Github::Error::ServiceError
- Github::Error::ServiceUnavailable
- Github::Error::Unauthorized
- Github::Error::UnknownValue
- Github::Error::UnprocessableEntity
- Github::Error::Validations
- Github::Gists
- Github::Gists::Comments
- Github::GitData
- Github::GitData::Blobs
- Github::GitData::Commits
- Github::GitData::References
- Github::GitData::Tags
- Github::GitData::Trees
- Github::Gitignore
- Github::Issues
- Github::Issues::Assignees
- Github::Issues::Comments
- Github::Issues::Events
- Github::Issues::Labels
- Github::Issues::Milestones
- Github::Jsonable
- Github::Markdown
- Github::Meta
- Github::MimeType
- Github::Normalizer
- Github::Orgs
- Github::Orgs::Members
- Github::Orgs::Teams
- Github::PageIterator
- Github::PageLinks
- Github::PagedRequest
- Github::Pagination
- Github::ParameterFilter
- Github::ParamsHash
- Github::PullRequests
- Github::PullRequests::Comments
- Github::RateLimit
- Github::Repos
- Github::Repos::Collaborators
- Github::Repos::Comments
- Github::Repos::Commits
- Github::Repos::Contents
- Github::Repos::Downloads
- Github::Repos::Forks
- Github::Repos::Hooks
- Github::Repos::Keys
- Github::Repos::Merging
- Github::Repos::PubSubHubbub
- Github::Repos::Statistics
- Github::Repos::Statuses
- Github::Request
- Github::Request::BasicAuth
- Github::Request::Jsonize
- Github::Request::OAuth2
- Github::Resource
- Github::Response
- Github::Response::Header
- Github::Response::Jsonize
- Github::Response::Mashify
- Github::Response::RaiseError
- Github::Response::Xmlize
- Github::ResponseWrapper
- Github::S3Uploader
- Github::Say
- Github::Scopes
- Github::Search
- Github::Users
- Github::Users::Emails
- Github::Users::Followers
- Github::Users::Keys
- Github::Utils
- Github::Utils::Url
- Github::VERSION
- Github::Validations
- Github::Validations::Format
- Github::Validations::Presence
- Github::Validations::Required
- Github::Validations::Token
- Hash

No matching classes.

# Github::Repos::Hooks

The Repository Hooks API manages the post-receive web and service hooks for a repository.

### Constants

REQUIRED_PARAMS
VALID_HOOK_PARAM_NAMES

### Public Instance Methods

all(*args) click to toggle source
Alias for: list
create(*args) click to toggle source

Create a hook

# Inputs

- `:name` - Required string - the name of the service that is being called.

- `:config` - Required hash - A Hash containing key/value pairs to provide settings for this hook.

- `:events` - Optional array - Determines what events the hook is triggered for. Default: ["push"]

- `:active` - Optional boolean - Determines whether the hook is actually triggered on pushes.

# Examples

    github = Github.new
    github.repos.hooks.create 'user-name', 'repo-name',
      "name" =>  "web",
      "active" => true,
      "config" => {
        "url" => "http://something.com/webhook"
        }
      }

    # File lib/github_api/repos/hooks.rb, line 85
    def create(*args)
      arguments(args, :required => [:user, :repo]) do
        sift VALID_HOOK_PARAM_NAMES, :recursive => false
        assert_required REQUIRED_PARAMS
      end

      post_request("/repos/#{user}/#{repo}/hooks", arguments.params)
    end

delete(*args) click to toggle source

Delete a hook

# Examples

    github = Github.new
    github.repos.hooks.delete 'user-name', 'repo-name', 'hook-id'

    # File lib/github_api/repos/hooks.rb, line 145
    def delete(*args)
      arguments(args, :required => [:user, :repo, :id])
      params = arguments.params

      delete_request("/repos/#{user}/#{repo}/hooks/#{id}", params)
    end

edit(*args) click to toggle source

Edit a hook

# Inputs

- `:name` - Required string - the name of the service that is being called.

- `:config` - Required hash - A Hash containing key/value pairs to provide settings for this hook.

- `:events` - Optional array - Determines what events the hook is triggered for. This replaces the entire array of events. Default: ["push"].

- `:add_events` - Optional array - Determines a list of events to be added to the list of events that the Hook triggers for.

- `:remove_events` - Optional array - Determines a list of events to be removed from the list of events that the Hook triggers for.

- `:active` - Optional boolean - Determines whether the hook is actually triggered on pushes.

# Examples

    github = Github.new
    github.repos.hooks.edit 'user-name', 'repo-name', 'hook-id',
      "name" => "campfire",
      "active" =>  true,
      "config" =>  {
        "subdomain" => "github",
        "room" =>  "Commits",
        "token" => "abc123"
      }

    # File lib/github_api/repos/hooks.rb, line 115
    def edit(*args)
      arguments(args, :required => [:user, :repo, :id]) do
        sift VALID_HOOK_PARAM_NAMES, :recursive => false
        assert_required REQUIRED_PARAMS
      end

      patch_request("/repos/#{user}/#{repo}/hooks/#{id}", arguments.params)
    end

find(*args) click to toggle source
Alias for: get
get(*args) click to toggle source

Get a single hook

# Examples

    github = Github.new
    github.repos.hooks.get 'user-name', 'repo-name', 'hook-id'

    # File lib/github_api/repos/hooks.rb, line 60
    def get(*args)
      arguments(args, :required => [:user, :repo, :id])

      get_request("/repos/#{user}/#{repo}/hooks/#{id}", arguments.params)
    end

Also aliased as: find
list(*args) click to toggle source

List repository hooks

# Examples

    github = Github.new
    github.repos.hooks.list 'user-name', 'repo-name'
    github.repos.hooks.list 'user-name', 'repo-name' { |hook| ... }

    # File lib/github_api/repos/hooks.rb, line 45
    def list(*args)
      arguments(args, :required => [:user, :repo])

      response = get_request("/repos/#{user}/#{repo}/hooks", arguments.params)
      return response unless block_given?
      response.each { |el| yield el }
    end

Also aliased as: all
test(*args) click to toggle source

Test a hook

This will trigger the hook with the latest push to the current repository.

# Examples

    github = Github.new
    github.repos.hooks.test 'user-name', 'repo-name', 'hook-id'

    # File lib/github_api/repos/hooks.rb, line 132
    def test(*args)
      arguments(args, :required => [:user, :repo, :id])
      params = arguments.params

      post_request("/repos/#{user}/#{repo}/hooks/#{id}/test", params)
    end

[Validate]

Generated with the Darkfish Rdoc Generator 2.