txghbot.IWebhook(Interface) interface documentation

Part of txghbot (View In Hierarchy)

Known implementations: txghbot.test.test_core.FakeWebhook

A Github webhook.

Method match Decide if this webhook should run for this event.
Method run Run the webhook
def match(eventName, eventData):

Decide if this webhook should run for this event.

ParameterseventNamethe name of the received Github event. (type: unicode/str)
eventDatathe deserialized event payload. (type: dict)
ReturnsTrue if this hook should run on this event; False otherwise. (type: bool)
def run(eventName, eventData, requestID):

Run the webhook

ParameterseventNamethe name of the received Github event. (type: unicode/str)
eventDatathe deserialized event payload. (type: dict)
requestIDthe identifier Github provided for this event. Useful for logging. (type: unicode/str)
ReturnsIf a twisted.internet.defer.Deferred is return, it must fire when this hook has finished running. Failures will be logged by WebhookDispatchingResource. All other results will be ignored. (type: twisted.internet.defer.Deferred or some immediate value.)
API Documentation for txghbot, generated by pydoctor at 2016-10-15 18:50:32.