Interface BitbucketWebhookClient
- All Known Implementing Classes:
BitbucketWebhookClientImpl
public interface BitbucketWebhookClient
A client to query for and register webhooks in Bitbucket Server.
-
Method Summary
Modifier and TypeMethodDescriptionvoid
deleteWebhook
(int webhookId) deletes a webhook with given idgetWebhooks
(String... eventId) Returns a stream of existing webhooks.registerWebhook
(BitbucketWebhookRequest request) Registers the given webhook in the Bitbucket Server.updateWebhook
(int id, BitbucketWebhookRequest request) Updates the existing webhook
-
Method Details
-
getWebhooks
Returns a stream of existing webhooks. Result could be further filtered by passing in event id filters. every subsequent fetch ofBitbucketPage
results in a remote call to Bitbucket server.- Parameters:
eventId
- , Event id filters. These ids are the same as the one recieved asBitbucketWebhookSupportedEvents
- Returns:
- a stream of webhooks.
-
registerWebhook
Registers the given webhook in the Bitbucket Server.- Parameters:
request
- Webhook details- Returns:
- returns the registered webhook
-
deleteWebhook
void deleteWebhook(int webhookId) deletes a webhook with given id- Parameters:
webhookId
- , webhook id.
-
updateWebhook
Updates the existing webhook- Parameters:
id
- webhook identifierrequest
- webhook with update field- Returns:
- updated webhook
-