It will be sent a POST request with the information of the [% terms.bugs %] that match with the events and filters selected to your URL.
- Documentation about webhooks is available here.
+ Documentation about webhooks is available
+ here.
diff --git a/extensions/Webhooks/template/en/default/pages/webhooks.html.tmpl b/extensions/Webhooks/template/en/default/pages/webhooks.html.tmpl
deleted file mode 100644
index c5f47dc2a4..0000000000
--- a/extensions/Webhooks/template/en/default/pages/webhooks.html.tmpl
+++ /dev/null
@@ -1,340 +0,0 @@
-[%# This Source Code Form is subject to the terms of the Mozilla Public
- # License, v. 2.0. If a copy of the MPL was not distributed with this
- # file, You can obtain one at http://mozilla.org/MPL/2.0/.
- #
- # This Source Code Form is | "Incompatible With Secondary Licenses", as
- # defined by the Mozilla Public License, v. 2.0.
- #%]
-
-[% PROCESS global/header.html.tmpl
- title = "Webhooks Documentation"
- style = "#bugzilla-body li {
- margin: 5px
- }
- h4 {
- margin-bottom: 0px
- }
- .heading {
- font-weight: bold
- }
- #main-inner{
- margin-left: 20%;
- margin-right: 20%;
- margin-bottom: 5%
- }
- "
-%]
-
-[% terms.Bugzilla %] Webhooks
-
-A webhook is a custom callback defined by events. Is triggered when those events happen, and a POST
-request is sent to a defined URL.
-
-In the case of [% terms.Bugzilla %], a webhook can be triggered by a change to, or creation of a [% terms.bug %]. The
-parameters of the [% terms.bug %] are exposed to the webhook handler which makes a callback (over HTTP) to another
-web application.
-
-Examples of [% terms.Bugzilla %] webhooks could include:
-
- - Updating a copy of the [% terms.Bugzilla %] [% terms.bug %] in another system such as Jira
- - Sending a message to a chat server such as Matrix or Slack
-
-
-Creating a webhook
-To create a webhook follow the next steps:
-
- - Access to your [% terms.Bugzilla %] Account.
- - Go to your Preferences Panel > Webhooks.
- - Fill out all of the parameters:
- Name
- A name for the webhook, which should be descriptive (e.g. “Jira Webhook for New & Updated [% terms.Bugs %] in Core::Graphics”)
-
- URL
- The URL which will receive and process the webhook.
-
- Events
- The [% terms.bug %] events that will trigger your new webhook.
-
- - When a new [% terms.bug %] is created
- - When an existing [% terms.bug %] is modified
- - When a new attachment is created
- - When an existing attachment is modified
- - When a new comment is created
-
-
- Filters
- Properties of a [% terms.bug %] that specify which [% terms.bugs %] you will receive.
-
- - Product: name of the product of the [% terms.bugs %] that you want to receive.
- - Component: name of the component of the [% terms.bugs %] that you want to receive.
- If you want to receive the [% terms.bugs %] of all the components of a product, select Any.
-
-
- API Keys
- If your endpoint requires authentication, you may optionally provide a header and API key for your endpoint.
- An example of a header may look like Authorization: Token zQ5TSBzq7tTZMtKYq9K1ZqJMjifKx3cPL7pIGk9Q.
- So you would enter Authorization for the API Key Header and
- Token zQ5TSBzq7tTZMtKYq9K1ZqJMjifKx3cPL7pIGk9Q for the API Key Value.
- Note: If one or both of the values are empty, the webhook will still send the data to your endpoint,
- but the request may fail if the endoint requires authentication.
-
- - Add the webhook.
-
-
-You can see your registered webhooks in the same panel.
-If you want to delete a webhook, select the webhook in “Your webhooks” table and click remove
-selected. You can select more than one.
-
-Delivered webhook
-When a webhook is triggered the HTTP POST of a fixed JSON structure payload that is delivered
-contains the webhook_id, webhook_name and the information about the [% terms.bug %] that matches the event and filters.
-
-If the [% terms.bug %] is private, only the [% terms.bug %] id and some other basic information is sent and the external system will
-need to query BMO over the REST API to get the actual details of the [% terms.bug %].
-
-The webhooks will be called in the same order as the events triggering them and will be one request per new
-[% terms.bug %] and per changed [% terms.bug %]. The "changes" parameter will be sent only when the triggered event is changed and will
-content every change made in the [% terms.bug %].
-
-Public [% terms.Bug %] Request
-<![CDATA[
-{
- "[% terms.bug %]": {
- "alias": "",
- "assigned_to": "nobody@mozilla.org",
- "assigned_to_detail": {
- "id": 1,
- "login": "nobody@mozilla.org",
- "real_name": "Nobody; OK to take it and work on it"
- },
- "classification": "Client Software",
- "comment": {
- "body": "another test comment",
- "creation_time": "2020-10-16T06:28:41",
- "id": 14748073,
- "is_private": false,
- "number": 2
- },
- "component": "Sync",
- "creation_time": "2020-10-16T06:24:06",
- "creator": "nobody@mozilla.org",
- "creator_detail": {
- "id": 1,
- "login": "nobody@mozilla.org",
- "real_name": "Nobody; OK to take it and work on it"
- },
- "flags": [],
- "id": 1629704,
- "is_private": false,
- "keywords": [],
- "last_change_time": "2020-10-16T06:26:21",
- "operating_system": "Unspecified",
- "platform": "Unspecified",
- "priority": "P1",
- "product": "Firefox",
- "qa_contact": "nobody@mozilla.org",
- "qa_contact_detail": {
- "id": 1,
- "login": "nobody@mozilla.org",
- "real_name": "Nobody; OK to take it and work on it"
- },
- "resolution": "",
- "severity": "--",
- "status": "NEW",
- "summary": "Webhook Test - Disregard",
- "target_milestone": "---",
- "type": "defect",
- "url": "",
- "version": "unspecified",
- "whiteboard": ""
- },
- "event": {
- "action": "modify",
- "routing_key": "bug.modify:priority"
- "target": "bug",
- "time": "2020-07-24T20:11:22",
- "user": {
- "id": 1,
- "login": "nobody@mozilla.org",
- "real_name": "Nobody; OK to take it and work on it"
- },
- "changes": [
- {
- "field": "priority",
- "removed": "P3",
- "added": "P1"
- }
- ]
- },
- "webhook_id": 23,
- "webhook_name": "test-bug"
-}
-]]>
-
-Private [% terms.Bug %] Request
-<![CDATA[
-{
- "[% terms.bug %]": {
- "id": 2,
- "is_private": true
- },
- "event": {
- "action": "modify",
- "routing_key": "bug.modify:priority"
- "target": "bug",
- "time": "2020-07-24T20:11:22",
- "user": {
- "id": 1,
- "login": "nobody@mozilla.org",
- "real_name": "Nobody; OK to take it and work on it"
- }
- },
- "webhook_id": 23,
- "webhook_name": "test-bug",
-}
-]]>
-
-Response
-HTTP 200 OK. The request has succeeded.
-
-New Comment
-<![CDATA[
-{
- "[% terms.bug %]": {
- "alias": "",
- "assigned_to": "nobody@mozilla.org",
- "assigned_to_detail": {
- "id": 1,
- "login": "nobody@mozilla.org",
- "real_name": "Nobody; OK to take it and work on it"
- },
- "classification": "Client Software",
- "comment": {
- "body": "another test comment",
- "creation_time": "2020-10-16T06:28:41",
- "id": 14748073,
- "is_private": false,
- "number": 2
- },
- "component": "Sync",
- "creation_time": "2020-10-16T06:24:06",
- "creator": "nobody@mozilla.org",
- "creator_detail": {
- "id": 1,
- "login": "nobody@mozilla.org",
- "real_name": "Nobody; OK to take it and work on it"
- },
- "flags": [],
- "id": 1629704,
- "is_private": false,
- "keywords": [],
- "last_change_time": "2020-10-16T06:26:21",
- "operating_system": "Unspecified",
- "platform": "Unspecified",
- "priority": "",
- "product": "Firefox",
- "qa_contact": "",
- "resolution": "",
- "severity": "--",
- "status": "NEW",
- "summary": "Webhook Test - Disregard",
- "target_milestone": "---",
- "type": "defect",
- "url": "",
- "version": "unspecified",
- "whiteboard": ""
- },
- "event": {
- "action": "create",
- "routing_key": "comment.create",
- "target": "comment",
- "time": "2020-10-16T06:28:41",
- "user": {
- "id": 1,
- "login": "nobody@mozilla.org",
- "real_name": "Nobody; OK to take it and work on it"
- }
- },
- "webhook_id": 23,
- "webhook_name": "test-comment"
-}
-]]>
-
-New Attachment
-<![CDATA[
-{
- "[% terms.bug %]": {
- "alias": "",
- "assigned_to": "nobody@mozilla.org",
- "assigned_to_detail": {
- "id": 1,
- "login": "nobody@mozilla.org",
- "real_name": "Nobody; OK to take it and work on it"
- },
- "attachment": {
- "content_type": "text/plain",
- "creation_time": "2020-10-16T07:08:12",
- "description": "test attachment",
- "file_name": "file_1629704.txt",
- "flags": [],
- "id": 9180115,
- "is_obsolete": false,
- "is_patch": false,
- "is_private": false,
- "last_change_time": "2020-10-16T07:08:12"
- }
- "classification": "Client Software",
- "component": "Sync",
- "creation_time": "2020-10-16T06:24:06",
- "creator": "nobody@mozilla.org",
- "creator_detail": {
- "id": 1,
- "login": "nobody@mozilla.org",
- "real_name": "Nobody; OK to take it and work on it"
- },
- "flags": [],
- "id": 1629704,
- "is_private": false,
- "keywords": [],
- "last_change_time": "2020-10-16T06:26:21",
- "operating_system": "Unspecified",
- "platform": "Unspecified",
- "priority": "",
- "product": "Firefox",
- "qa_contact": "",
- "resolution": "",
- "severity": "--",
- "status": "NEW",
- "summary": "Webhook Test - Disregard",
- "target_milestone": "---",
- "type": "defect",
- "url": "",
- "version": "unspecified",
- "whiteboard": ""
- },
- "event": {
- "action": "create",
- "routing_key": "attachment.create",
- "target": "attachment",
- "time": "2020-10-16T07:08:12",
- "user": {
- "id": 1,
- "login": "nobody@mozilla.org",
- "real_name": "Nobody; OK to take it and work on it"
- }
- },
- "webhook_id": 23,
- "webhook_name": "test-attachment"
-}
-]]>
-
-Errors
-If the response is not 200, the [% terms.Bugzilla %] system will retry 4 attempts, waiting 5s, 10s, 15s and
-20s between each attempt. If none of those attempts is successful, the system will continue trying
-every 15 minutes.
-
-If a message is stuck without a successful attempt, the next messages that trigger the webhook
-will be stored in a queue in the order that were triggered and will be delivered in that order when
-the first message in the queue is delivered.
-
-[% INCLUDE global/footer.html.tmpl %]