HTTP Hooks

[OO00O0O]

GitHub type HTTP hooks for integrations.

[CoderCow]

Open Questions

• What exactly is GitHub's "Secret" setting and is something like this useful for Bonobo hooks? Will be supported.
• Should hooks support http basic auth? Request signing is better.
• Is a different format than JSON actually useful? Will support JSON only for now.
• In what format should webhooks be sent? Offer to choose between different formatters.

Purposed Solution

Triggers for Hooks

Application Triggers

• Repository Added
• Repository Deleted
• User Added
• User Deleted
• Team Added
• Team Removed
• Team Members Modified

Hooks for application triggers will be configured in the Bonobo settings.

Repository Triggers

• Branch Created
• Branch Deleted
• Branch Modified
• Tag Created
• Tag Deleted
• Repository User Access Modified (triggers for user, team or admin changes)
• Repository Anonymous View Policy Changed
• Repository Push Mode Changed

Hooks for repository triggers can be configured on a per repository basis and globally as part of the Bonobo settings. Whether the global hooks are triggered for a specific repository can be configured in each repository's settings.

Webhooks

Multiple webhooks can be configured for each trigger. The user can

• set a custom name and a url to invoke,
• activate and deactivate them,
• test them in the web interface and get immediate feedback,
• turn SSL certification on or off per hook,
• configure which formatter to use when sending requests.

Webhook Formatters

When a webhook is configured the user will be able to choose from a list of available formatter implementations. This is to ensure maximum compatibility with other services, because we can't expect them to support a Bonobo specific request format.

Initial implementations will be:

Formatter	Capabilities	Description
GitHub	Branch and Tag Events only	Tries to mimic GitHub webhooks as good as possible. Might not work with all services because Bonobo can't provide all of the data GitHub provides.
Slack	Every Trigger Supported	Can be used with a simple "Incoming Webhook" in Slack and will format simple Slack messages to announce Bonobo events.
Bonobo	Every Trigger Supported	Formats requests in a Bonobo specific way. This allows us to provide all interesting information about an event as parsable JSON data so that there's at least the possibility for other services to support Bonobo and for users to do whatever they want with the incoming data on their own servers.

[CoderCow]

GitHub's secret setting allows the sending server to sign the payload data in the webhook request so that the receiving server can verify the legitimacy of the Git server and the request.

Beacause I generally like to have some form of authenticity for the hook requests and because this seems to be a better solution than using http basic auth, I'll make the GitHub and Bonobo formatter support this.