Webhooks

Retry Delivery

Sends a finished delivery again, with the same event id and body. Use the event id to recognize a repeat.

POST
/v1/webhooks/{id}/deliveries/{deliveryId}/retry

Authorization

Bearer
headerAuthorizationBearer <op_>

Workspace API key, sent as Authorization: Bearer op_... Keys are created in the dashboard.

Path Parameters

id*string
Length1 <= length
deliveryId*string
Length1 <= length

Header Parameters

Idempotency-Key?string

A unique key, such as a UUID, that makes retrying this request safe. A repeat with the same key and body within 24 hours returns the first response instead of acting again. A 429 or 5xx response is not kept, so a retry with the same key runs again.

Length1 <= length <= 255

Response Body

The delivery, queued again

application/json
  1. response
id*string
webhookId*string
eventId*string

The event's id, also sent as the Onepostly-Event-Id header.

eventType*string
status*|

pending while attempts remain, then success or failed. New values can be added, so handle a value you do not know.

attempts*integer

Times the event was sent to your endpoint so far.

responseStatus*|

HTTP status your endpoint last answered with.

lastError*|

Why the last attempt failed. Null after a success.

createdAt*string

When the event was created.

Formatdate-time
deliveredAt*|

When your endpoint accepted the event. Null until it does.

Formatdate-time
payload?unknown

The JSON body that is sent, exactly as it is signed.

Example Request
import { Configuration, WebhooksApi } from "@onepostly/sdk";const webhooksApi = new WebhooksApi(  new Configuration({ accessToken: process.env.ONEPOSTLY_API_KEY }));const response = await webhooksApi.retryWebhookDelivery({  id: "whk_e5c7a3f18b2d4e69a04c3f9d1b7e2c58",  deliveryId: "dlv_9f3e6b2a4c1d4a8eb7f51d2c8e0a6b03",});console.log(response);
Example Response
{  "id": "dlv_9f3e6b2a4c1d4a8eb7f51d2c8e0a6b03",  "webhookId": "whk_e5c7a3f18b2d4e69a04c3f9d1b7e2c58",  "eventId": "evt_7c41e09a5b3d4f2e8a6c1b9d0e3f5a03",  "eventType": "account.revoked",  "status": "pending",  "attempts": 0,  "responseStatus": null,  "lastError": null,  "createdAt": "2027-03-15T11:00:00.318Z",  "deliveredAt": null,  "payload": {    "id": "evt_7c41e09a5b3d4f2e8a6c1b9d0e3f5a03",    "type": "account.revoked",    "createdAt": "2027-03-15T11:00:00.318Z",    "organizationId": "5b0e7c1a-2f4d-4c8e-9a3b-6d1f0e2c4a7b",    "data": {      "object": {        "id": "acc_YOUR_TIKTOK_ACCOUNT_ID",        "platform": "tiktok",        "handle": "yourbrand",        "status": "revoked",        "reason": "token_invalid",        "tokenExpiresAt": "2027-03-16T09:00:00.000Z",        "previousStatus": "active"      }    }  }}