Effects

Report the outcome of a leased effect

Closes out an effect you hold the lease for. Reporting "succeeded" records a result that later duplicate callers replay instead of re-running the action. Reporting "failed" asserts the action did not happen, which permits a fresh attempt.

post/v1/effects/{effectId}/report

Request

  • Base URL: https://ratchetgate.com
  • URL: https://ratchetgate.com/v1/effects/{effectId}/report
  • Auth: HTTP bearer

Path parameters

effectIdstring required

Request body

lease_tokenstring required
outcome'succeeded' | 'failed' required

Report "failed" ONLY when you know the side effect did not reach the outside world. If you are unsure, report nothing and let the lease lapse — that records an honest indeterminate.

resultunknown
failure_reasonstring
actual_cost_microsinteger

Response

Default Response

effect_idstring
statestring
attemptinteger
settled_atstring nullable
actual_cost_microsinteger

Changes

No recorded changes to this operation across all 1 revision of this API.