Options
All
  • Public
  • Public/Protected
  • All
Menu

The context of the event that was triggered, including the payload and helpers for extracting information can be passed to GitHub API calls.

 module.exports = app => {
   app.on('push', context => {
     context.log('Code was pushed to the repo, what should we do with it?');
   });
 };
property

{github} github - A GitHub API client

property

{payload} payload - The webhook event payload

property

{logger} log - A logger

Hierarchy

  • WebhookEvent

Implemented by

Index

Properties

event

event: string

host

host: string

id

id: string

payload

protocol

protocol: "http" | "https"

url

url: string

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method

Generated using TypeDoc