package github

  1. Overview
  2. Docs

Module Repo.HookSource

The Hook module provides access to GitHub's webhooks API which lets you manage a repository's post-receive hooks.

Sourceval for_repo : ?token:Token.t -> user:string -> repo:string -> unit -> Github_t.hook Stream.t

for_repo ~user ~repo () is a stream of hooks for repo user/repo.

Sourceval get : ?token:Token.t -> user:string -> repo:string -> id:int64 -> unit -> Github_t.hook Response.t Monad.t

get ~user ~repo ~id () is hook id for repo user/repo.

Sourceval create : ?token:Token.t -> user:string -> repo:string -> hook:Github_t.new_hook -> unit -> Github_t.hook Response.t Monad.t

create ~user ~repo ~hook () is a newly created post-receive hook for repo user/repo as described by hook.

Sourceval update : ?token:Token.t -> user:string -> repo:string -> id:int64 -> hook:Github_t.update_hook -> unit -> Github_t.hook Response.t Monad.t

update ~user ~repo ~id ~hook () is the updated hook id in repo user/repo as described by hook.

Sourceval delete : ?token:Token.t -> user:string -> repo:string -> id:int64 -> unit -> unit Response.t Monad.t

delete ~user ~repo ~id () activates after hook id in repo user/repo has been deleted.

Sourceval ping : ?token:Token.t -> user:string -> repo:string -> id:int64 -> unit -> unit Response.t Monad.t

ping ~user ~repo ~id () trigger a ping event to be sent to the hook id in repo user/repo.

Sourceval test : ?token:Token.t -> user:string -> repo:string -> id:int64 -> unit -> unit Response.t Monad.t

test ~user ~repo ~id () activates after a push event for the lastest push to user/repo has been synthesized and sent to hook id.

Sourceval parse_event : constr:string -> payload:string -> unit -> Github_t.event_hook_constr

parse_event ~constr ~payload () is the event with constructor constr that is represented by payload.

Sourceval parse_event_metadata : payload:string -> unit -> Github_t.event_hook_metadata

parse_event_metadata ~payload () is the event metadata for the serialized event payload.