Skip to main content
POST
Replay a webhook delivery
The reference panel describes the current v3 operation. The notes below describe its v2 compatibility API. Follow the v3 request schema for current calls: v3 can move identifiers from the body or query into the URL. Keep the v2 method, path, and payload together when using the compatibility API.

v2 compatibility notes

POST /api/v2/webhooks/deliveries/replay Re-send one of the calling External App’s past deliveries. The replay is a new delivery of the same event: it gets a new delivery id (its own X-Forge-Delivery header, stable across its retries) and carries replayedFrom, while the envelope id — the event id — is unchanged. A receiver that deduplicates on the envelope id treats the replay as a duplicate rather than a second event.

Authentication

External App credential. Requires permission webhooks:manage. Replay also re-checks, at replay time, that the app still holds the event’s subscription scope, exactly as live delivery does.

Request body

string
required
The delivery to replay: the X-Forge-Delivery header value from the original delivery.

Responses

string
Id of the new delivery the replay created.
string
The delivery this replay was created from.
The response status is 202: the delivery is queued, not yet sent.

Retrying with an Idempotency-Key

A repeat under the same Idempotency-Key returns the stored 202 response with Idempotency-Replayed: true and queues nothing new, while both deliveries still belong to a subscription the calling app owns. Otherwise the repeat answers 409 idempotency_result_unavailable.

Authorizations

Authorization
string
header
required

An External App: the JWT it obtains from POST /oauth/token with OAuth2 client_credentials. Pass as Authorization: Bearer <jwt>. An app's static companion key also authenticates as the app, but is deprecated and is not protected by Idempotency-Key.

Headers

Idempotency-Key
string

1–255 printable ASCII characters (0x21–0x7E, no spaces), scoped to the calling credential. A repeat with the same key and request never runs the write again, a 5xx included: once the operation's permissions pass again it answers the identical status and body of the first response (Idempotent-Replayed: true, also sent as Idempotency-Replayed: true), unless the operation's own replay policy withholds it; a first response that was not stored (over 32 KiB, or carrying a one-time secret) answers its first status with only data.id (Idempotency-Replay-Disclosure: id-only) when it named one; otherwise 409 idempotency_result_unavailable; a repeat while the first is still running is 409 idempotency_key_in_flight, and the same key with a different request is 422 idempotency_key_reuse. Honoured for External App JWTs and platform and Personal keys; an External App's static companion key is not protected.

Required string length: 1 - 255

Path Parameters

deliveryId
string
required

The delivery to replay: the original X-Forge-Delivery header value

Response

Replay queued

data
object
required
meta
object
required