View Source Tentacat.Organizations.Hooks (Tentacat v2.5.0)

Summary

Functions

Create webhook for an organization.

Get a webhook for an organization by id.

List hooks of an organization.

This will trigger a ping event to be sent to the hook.

Delete an organization's webhook by it's Id.

Functions

Link to this function

create(client, organization, body)

View Source
@spec create(Tentacat.Client.t(), binary(), list()) :: Tentacat.response()

Create webhook for an organization.

Example

Tentacat.Organizations.Hooks.create(client, "github", hook_body)

More info at: http://developer.github.com/v3/orgs/hooks/#create-a-hook

Link to this function

find(client, organization, hook_id)

View Source

Get a webhook for an organization by id.

Example

Tentacat.Organizations.Hooks.find(client, "github", "1234567")

More info at: http://developer.github.com/v3/orgs/hooks/#get-single-hook

Link to this function

list(client \\ %Client{}, organization)

View Source

List hooks of an organization.

The response will differ if the authenticated user is also owner of the organization

Example

Tentacat.Organizations.Hooks.list "github"
Tentacat.Organizations.Hooks.list client, "github"

More info at: http://developer.github.com/v3/orgs/hooks/#list-hooks

Link to this function

ping(client, organization, hook_id)

View Source

This will trigger a ping event to be sent to the hook.

Example

Tentacat.Organizations.Hooks.ping(client, "github", "1234567")

More info at: http://developer.github.com/v3/orgs/hooks/#ping-a-hook

Link to this function

remove(client, organization, hook_id)

View Source
@spec remove(Tentacat.Client.t(), binary(), binary() | integer()) ::
  Tentacat.response()

Delete an organization's webhook by it's Id.

Example

Tentacat.Organizations.Hooks.remove(client, "github", "1234567")

More info at: http://developer.github.com/v3/orgs/hooks/#delete-a-hook

Link to this function

update(client, organization, hook_id, body)

View Source
@spec update(Tentacat.Client.t(), binary(), binary() | integer(), map()) ::
  Tentacat.response()

Update organization.

Sample body content:

hook_body = %{
  "name" => "web",
  "active" => true,
  "events" => [ "push", "pull_request" ],
  "config" => {
    "url" => "http://example.com/webhook",
    "content_type" => "json"
  }
}

Example

Tentacat.Organizations.Hooks.update(client, "github", "1234567", hook_body)

More info at: http://developer.github.com/v3/orgs/hooks/#edit-a-hook