Set a test sink behavior program

Replaces a sink's behavior program. The program is resolved against the number of deliveries the sink has already taken, so forDeliveries counts from the next delivery rather than from the sink's creation. Repeating the identical program is idempotent and changes nothing an integrator can observe.

put/v1/test-sinks/{sinkId}/program

Request

  • Base URL: https://docs.greatwait.dev (the document declares no server; this is the origin it was published from)
  • URL: https://docs.greatwait.dev/v1/test-sinks/{sinkId}/program
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer and API key in header Greatwait-Environment and API key in header Greatwait-Project

Path parameters

sinkIdstring required

Request body

behavior'client_error' | 'defer_abandon' | 'defer_fail' | 'defer_succeed' | 'delay' | 'disconnect' | 'duplicate' | 'invalid_signature' | 'rate_limited' | 'server_error' | 'success' | 'timeout' required
completionDelayMsinteger
delayMsinteger
forDeliveriesinteger
retryAfterSecondsinteger
statusinteger
then'client_error' | 'defer_abandon' | 'defer_fail' | 'defer_succeed' | 'delay' | 'disconnect' | 'duplicate' | 'invalid_signature' | 'rate_limited' | 'server_error' | 'success' | 'timeout'

Response

Set a test sink behavior program

createdAtstring required
deliveryCountinteger required
endpointstring required
environmentKind'test' required
idstring required
projectstring required
updatedAtstring required
urlstring uri required

Changes

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