Webhooks notify your app when certain events happen in Bitbucket. When an event you have subscribed to occurs, Bitbucket will make a POST request containing JSON data relating to the event to the URL you specified.
To receive webhook events, your app should include the webhook
module declaration in its JSON descriptor. The declaration indicates the
relative URL of the local resource where it will receive the
notification. Bitbucket sends an HTTP
POST to this resource in response to an event. Within your app, the code
that handles the POST should process any information passed in the body of
the message. Each webhook POST sent to your app will
also include the authentication headers that allow your app to authenticate that request. Specifically, the JWT token can be found
in the Authorization
HTTP header.
Note that some proxies will strip out the Authorization
header by
default (e.g. Apache and mod_wsgi) so extra configuration may be required
to ensure the Authentication header is visible.
event
Type | |
Max length | 64 |
Required | Yes |
Allowed values |
|
Description | The event identifier |
url
Type | |
Max length | 2048 |
Format | uri-template |
Required | Yes |
params
Type |
Rate this page: