retryWebhook
WebhooksLogWrapper retryWebhook(id)
PUT /api/2.0/settings/webhook/{id}/retry
Retry a webhook delivery
Sends one past webhook delivery again. The id in the path is that of a delivery record from GET api/2.0/settings/webhooks/log, not of a subscription, and the payload kept in that record is sent once more to the subscription it belongs to. The work is asynchronous: a fresh delivery record is created and queued at once, and the response describes that new record, with an identifier of its own and with status and delivery not filled in yet. To learn the outcome, read GET api/2.0/settings/webhooks/log with eventId set to the returned identifier until delivery appears. The original record stays as it is, and every call queues one more attempt, so this is not safe to repeat blindly. A DocSpaceAdmin may retry any delivery in the portal, anyone else only deliveries of the subscriptions they created, and a Guest is refused. An id of 0 is rejected as an invalid request and an unknown one gives 404. The operation is rate limited, so a burst of calls is answered with 429; to retry several records use PUT api/2.0/settings/webhook/retry.
Parameters
| Name | In | Type | Description | Notes |
|---|---|---|---|---|
| id | path | Integer (int32) | The identifier of the object the operation acts on, as the listing operation of that kind of object reports it. It has to match the shape the route declares - a GUID where the route is typed as one - since a value of another shape does not match the route at all and is answered as not found. | [required] [example: 1] |
Responses
| Status code | Description | Type | Response headers |
|---|---|---|---|
| 200 | The newly queued delivery record, with its status and delivery moment not filled in yet | WebhooksLogWrapper | X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset |
| 400 | The delivery record identifier is 0 | - | - |
| 403 | The delivery belongs to another member's subscription, or the caller may not use webhooks | - | - |
| 404 | No delivery record with this ID exists in the portal | - | - |
| 401 | Unauthorized | ErrorApiResponse | - |
| 429 | Too Many Requests. | ErrorApiResponse | Retry-After |
| 500 | Internal Server Error. | ErrorApiResponse | - |
| 502 | Bad Gateway. Returned by the reverse proxy, response body may be HTML and not JSON. | - | - |
| 503 | Service Unavailable. Returned by the reverse proxy, response body may be HTML and not JSON. | - | - |
Return type
Authorization
Basic, OAuth2 (scopes: read, write), ApiKeyBearer, asc_auth_key, Bearer, OpenId
HTTP request headers
- Content-Type: Not defined
- Accept: application/json