Sign in

v4

latestOpenAPI 3.0.1Apache 2.02026-08-016169702.3 MB
Webhooks

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

get/rest/api/3/webhook/failed

Query parameters

maxResultsinteger

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.

afterinteger

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

Response

Returned if the request is successful.

maxResultsinteger 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.

nextstring uri

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).