org.everit.atlassian.restclient.jiracloud.v2.api

Class WebhooksApi

java.lang.Object

org.everit.atlassian.restclient.jiracloud.v2.api.WebhooksApi

public class WebhooksApi
extends Object

Constructor Summary

Constructors

Constructor and Description
WebhooksApi(org.everit.http.restclient.RestClient restClient)

Method Summary

Modifier and Type	Method and Description
io.reactivex.Completable	deleteWebhookById(ContainerForWebhookIDs containerForWebhookIDs, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Delete webhooks by ID Removes webhooks by ID.
io.reactivex.Single<PageBeanWebhook>	getDynamicWebhooksForApp(Optional<Long> startAt, Optional<Integer> maxResults, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Get dynamic webhooks for app Returns a [paginated](#pagination) list of the webhooks registered by the calling app.
io.reactivex.Single<FailedWebhooks>	getFailedWebhooks(Optional<Integer> maxResults, Optional<Long> after, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Get failed webhooks Returns webhooks that have recently failed to be delivered to the requesting app after the maximum number of retries.
io.reactivex.Single<WebhooksExpirationDate>	refreshWebhooks(ContainerForWebhookIDs containerForWebhookIDs, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Extend webhook life Webhooks registered through the REST API expire after 30 days.
io.reactivex.Single<ContainerForRegisteredWebhooks>	registerDynamicWebhooks(WebhookRegistrationDetails webhookRegistrationDetails, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Register dynamic webhooks Registers webhooks.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

WebhooksApi

public WebhooksApi(org.everit.http.restclient.RestClient restClient)

Method Detail

deleteWebhookById

public io.reactivex.Completable deleteWebhookById(ContainerForWebhookIDs containerForWebhookIDs,
                                                  Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Delete webhooks by ID Removes webhooks by ID. Only webhooks registered by the calling Connect app are removed. If webhooks created by other apps are specified, they are ignored. **[Permissions](#permissions) required:** Only [Connect apps](https://developer.atlassian.com/cloud/jira/platform/integrating-with-jira-cloud/#atlassian-connect) can use this operation.

Parameters:

containerForWebhookIDs - (required)

restRequestEnhancer -

Adds the possibility to modify the rest request before sending out. This can be useful to add authorizations tokens for example.

Returns:

Completable

getDynamicWebhooksForApp

public io.reactivex.Single<PageBeanWebhook> getDynamicWebhooksForApp(Optional<Long> startAt,
                                                                     Optional<Integer> maxResults,
                                                                     Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Get dynamic webhooks for app Returns a [paginated](#pagination) list of the webhooks registered by the calling app. **[Permissions](#permissions) required:** Only [Connect apps](https://developer.atlassian.com/cloud/jira/platform/integrating-with-jira-cloud/#atlassian-connect) can use this operation.

Parameters:

startAt - The index of the first item to return in a page of results (page offset). (optional, default to 0l)

maxResults - The maximum number of items to return per page. (optional, default to 100)

restRequestEnhancer -

Adds the possibility to modify the rest request before sending out. This can be useful to add authorizations tokens for example.

Returns:

Single<PageBeanWebhook>

getFailedWebhooks

public io.reactivex.Single<FailedWebhooks> getFailedWebhooks(Optional<Integer> maxResults,
                                                             Optional<Long> after,
                                                             Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Get failed webhooks Returns webhooks that have recently failed to be delivered to the requesting app after the maximum number of retries. After 72 hours the failure may no longer be returned by this operation. The oldest failure is returned first. This method uses a cursor-based pagination. To request the next page use the failure time of the last webhook on the list as the `failedAfter` value or use the URL provided in `next`. **[Permissions](#permissions) required:** Only [Connect apps](https://developer.atlassian.com/cloud/jira/platform/integrating-with-jira-cloud/#atlassian-connect) can use this operation.

Parameters:

maxResults - The maximum number of webhooks to return per page. If obeying the maxResults directive would result in records with the same failure time being split across pages, the directive is ignored and all records with the same failure time included on the page. (optional)

after - The time after which any webhook failure must have occurred for the record to be returned, expressed as milliseconds since the UNIX epoch. (optional)

restRequestEnhancer -

Adds the possibility to modify the rest request before sending out. This can be useful to add authorizations tokens for example.

Returns:

Single<FailedWebhooks>

refreshWebhooks

public io.reactivex.Single<WebhooksExpirationDate> refreshWebhooks(ContainerForWebhookIDs containerForWebhookIDs,
                                                                   Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Extend webhook life Webhooks registered through the REST API expire after 30 days. Call this resource periodically to keep them alive. Unrecognized webhook IDs (nonexistent or belonging to other apps) are ignored. **[Permissions](#permissions) required:** Only [Connect apps](https://developer.atlassian.com/cloud/jira/platform/integrating-with-jira-cloud/#atlassian-connect) can use this operation.

Parameters:

containerForWebhookIDs - (required)

restRequestEnhancer -

Adds the possibility to modify the rest request before sending out. This can be useful to add authorizations tokens for example.

Returns:

Single<WebhooksExpirationDate>

registerDynamicWebhooks

public io.reactivex.Single<ContainerForRegisteredWebhooks> registerDynamicWebhooks(WebhookRegistrationDetails webhookRegistrationDetails,
                                                                                   Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Register dynamic webhooks Registers webhooks. **[Permissions](#permissions) required:** Only [Connect apps](https://developer.atlassian.com/cloud/jira/platform/integrating-with-jira-cloud/#atlassian-connect) can use this operation.

Parameters:

webhookRegistrationDetails - (required)

restRequestEnhancer -

Adds the possibility to modify the rest request before sending out. This can be useful to add authorizations tokens for example.

Returns:

Single<ContainerForRegisteredWebhooks>