Get failed webhooks

GET

/rest/api/3/webhook/failed

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 required: Only Connect apps can use this operation.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'http://jira.local:8080/jira/rest//rest/api/3/webhook/failed'

Response Example

200 - Success

{"values":[{"id":"1","body":"{\"data\":\"webhook data\"}","url":"https://example.com","failureTime":1573118132000},{"id":"2","url":"https://example.com","failureTime":1573540473480}],"maxResults":100,"next":"https://your-domain.atlassian.net/rest/api/3/webhook/failed?failedAfter=1573540473480&maxResults=100"}

Request

Query Params

maxResults

integer

optional

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.

after

integer

optional

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

Responses

🟢200Returned if the request is successful.

application/json

Body

A page of failed webhooks.

maxResults

integer <int32>

required

The maximum number of items on the page. If the list of values is shorter than this number, then there are no more pages.

string <uri>

optional

The URL to the next page of results. Present only if the request returned at least one result.The next page may be empty at the time of receiving the response, but new failed webhooks may appear in time. You can save the URL to the next page and query for new results periodically (for example, every hour).

values

array[object (FailedWebhook) {4}]

required

The list of webhooks.

body

string

optional

The webhook body.

failureTime

integer <int64>

required

The time the webhook was added to the list of failed webhooks (that is, the time of the last failed retry).

string

required

The webhook ID, as sent in the X-Atlassian-Webhook-Identifier header with the webhook.

url

string

required

The original webhook destination.

🟠400400 response

🟠403Returned if the caller is not a Connect app.

Modified at 2023-07-13 03:27:27

Delete webhooks by ID

Extend webhook life