TextKitDocs

Replay every failed delivery to an endpoint

Queues each event whose deliveries to this endpoint all failed between since and until (default: the last 24 hours; at most 7 days and 50 events a call).

POST/v1/webhooks/{id}/replay

Path Parameters

  • idstringrequired

    Example: we_a1B2c3D4e5F6.

Body Parameters

The body is optional.

  • sincestring (date-time)

    ISO date or epoch milliseconds. Default: 24 hours before until.

  • untilstring (date-time)

    ISO date or epoch milliseconds. Default: now.

Details

Queued events go out within 5 minutes, with the normal retry schedule. more: true means call again.

The endpoint must be active. To send one event now, use POST /v1/events/{id}/replay.

Scope: webhooks:write.

Responses

  • 200JSON object

    What was queued

  • 401Error

    Missing, malformed, or revoked API key

  • 402Error

    Billable live calls only: the prepaid credit balance cannot cover the call (insufficient_credits); nothing was done or charged

  • 409Error

    The endpoint is paused

  • 429Error

    Rate limit or quota exceeded

Response Fields

  • objectwebhook_replay
  • endpoint_idstring
  • sincestring (date-time)
  • untilstring (date-time)
  • queuedinteger
  • missingarray of string

    Event ids past the 30-day event retention.

  • moreboolean
  • limitinteger

    Example: 50.

Errors

Every error has the same JSON shape, and request_id matches the X-Request-Id response header. Errors lists every code and what to do about it.

  • 401

    Missing, malformed, or revoked API key

  • 402

    Billable live calls only: the prepaid credit balance cannot cover the call (insufficient_credits); nothing was done or charged

  • 409

    The endpoint is paused

  • 429

    Rate limit or quota exceeded