WebHook Resource¶

Added in 2.5

A resource for managing webhooks.

Webhooks are HTTP-based callbacks. When events are triggered on Review Board (such as a review request being published), a webhook can be configured to make a request to a URL with a payload.

Webhooks can be triggered by the following events:

• Review requests being published (review_request_published).

• Review requests being closed (review_request_closed).

• Reviews being published (review_published).

• Review replies being published (reply_published).

• All of the above (*).

The payload that is sent depends on the type of event. Review Board will generate a default payload for each event, or it can be overridden by providing your payload as the custom_content field.

By default, the generated payload will be a JSON payload. This can be changed by setting the encoding field to the appropriate value. Valid encodings are:

• application/json

• application/xml

• application/x-www-form-encoded

Payloads can also be signed with a 128-byte secret given in the secret field. If provided, the payload will be signed with the HMAC algorithm.

Webhooks can apply to all repositories, a select number of repositories, or to no repositories. In the latter case, they will only trigger with attachment-only review requests.

Webhooks are Local Site-dependant. They will only trigger for repositories in the configured local site. If no Local Site is configured, they will apply to review requests without a Local Site. If a webhook is configured to trigger for a specific set of repositories, the webhook and all repositories must be in the same Local Site.

$ curl https://reviews.example.com/api/webhooks/1/ -H "Accept: application/json"

HTTP 200 OK
Content-Length: 498
Content-Type: application/vnd.reviewboard.org.webhook+json
ETag: 524c3da67fab87d14cae9eb97f971c3387c15925
Vary: Accept, Cookie
X-Content-Type-Options: nosniff

{
  "stat": "ok",
  "webhook": {
    "apply_to": "all",
    "custom_content": null,
    "enabled": true,
    "encoding": "application/json",
    "events": [
      "*"
    ],
    "extra_data": {},
    "id": 1,
    "links": {
      "delete": {
        "href": "https://reviews.example.com/api/webhooks/1/",
        "method": "DELETE"
      },
      "self": {
        "href": "https://reviews.example.com/api/webhooks/1/",
        "method": "GET"
      },
      "update": {
        "href": "https://reviews.example.com/api/webhooks/1/",
        "method": "PUT"
      }
    },
    "repositories": [],
    "secret": "",
    "url": "http://example.com/webhook"
  }
}