Reset destination record settings
DELETE/v1/destinations/{destinationId}/record-settingspreview
Store the request and the response of every later delivery attempt again, as a new destination does. Records already stored are kept until they expire. Repeating the request keeps the defaults in effect.
Path parameters
destinationIdstring RequiredA destination ID, starting with dst_.
Returns
The command completed.200
dataobject RequiredOne destination with its recent delivery history.
idstring RequiredA destination ID, starting with dst_.
namestring RequiredHuman-readable label for the destination.
kindstring RequiredTransport. Currently only “webhook”.
urlstring (uri) RequiredWhere the request is sent.
eventTypesstring[] RequiredEvent types this destination receives, matched exactly. Empty receives every type; otherwise the event type must be one of them. Stored sorted, without duplicates.
At most 100 items
channelsstring[] RequiredChannels this destination receives. Empty receives every event, with or without channels. Otherwise the event must name at least one of them, so an event that names no channel never reaches it. Stored sorted, without duplicates.
At most 100 items
transformIdstring | null RequiredThe transform every attempt runs before it is signed. Null: payloads are sent as received.
enabledboolean RequiredA disabled destination receives no new deliveries; deliveries already created still run. The only way to receive nothing.
keepTryingboolean RequiredTrue keeps trying this destination however many attempts fail; it is never paused automatically.
retryPayloadRejectionsboolean RequiredTrue retries a delivery answered with 400, 413 or 422 on the normal schedule. False fails it on that attempt.
autoPauseobject | null RequiredSet while the destination is paused for failing: new events still wait for it, nothing is attempted, and resuming sends them. Null otherwise.
signingSecretLast4string RequiredThe last four characters of the signing secret, for recognizing it in a masked display.
healthstring RequiredOne label for whether this destination needs attention. suspended: the circuit is open or probing, or it is paused for failing. unused: nothing was ever accepted. failing: a failure is counted since the last success, or the 24h success rate is below 50%. idle: deliveries exist but none settled in 24h. healthy otherwise.
Allowed values: "healthy", "failing", "idle", "unused", "suspended"
successRate24hnumber | null RequiredPercentage of deliveries settled in the last 24 hours that were delivered: delivered24h / (delivered24h + failed24h). A retried attempt is neither. Null when nothing settled, so an unused destination is not reported as zero.
attempts24hnumber RequiredCompleted delivery attempts in the last 24 hours, retries included: the traffic figure.
delivered24hnumber RequiredDeliveries settled as delivered in the last 24 hours.
failed24hnumber RequiredDeliveries settled as failed in the last 24 hours after an attempt. A delivery that failed inside PayloadPuffin without reaching the destination doesn’t count here.
lastDeliveryAtstring | null RequiredAcceptance time of the most recent delivery to this destination. Null when there is none.
timeoutMsnumber RequiredPer-attempt timeout. The request is aborted once it elapses.
maxConcurrencynumber RequiredHow many attempts to this destination can run at once. Five unless you set it.
rateLimitPerSecondnumber RequiredThe most requests per second this destination is sent. Your plan’s delivery rate unless you set it.
rateLimitBurstnumber RequiredHow many requests can go out together before the rate applies. The rate unless you set it; one spaces requests evenly.
usesDefaultDeliveryPolicyboolean RequiredTrue when concurrency, rate limit and burst all follow the defaults, so a change to a default applies here.
storeRequestsboolean RequiredWhether the request sent on each delivery attempt is stored. Defaults to true.
storeResponsesboolean RequiredWhether the destination’s response to each delivery attempt is stored. Defaults to true.
cooldownUntilstring | null RequiredUntil when nothing is sent, because the destination answered with Retry-After. Null when it isn’t cooling down.
circuitStatestring Requiredclosed: deliveries go out. open: the destination failed repeatedly, and nothing is sent until circuitOpenUntil. half_open: one attempt is testing whether it recovered.
Allowed values: "closed", "open", "half_open"
circuitFailureCountnumber RequiredFailed attempts in a row since the last success.
circuitOpenUntilstring | null RequiredWhen the circuit lets one test attempt through. Null while it is closed.
hasPreviousSigningSecretboolean RequiredTrue while the previous signing secret is still accepted, so a rotated secret can be rolled out gradually.
previousSigningSecretExpiresAtstring | null RequiredWhen the previous signing secret stops signing. Null unless it is still active; a rotation is refused until then.
previousSigningSecretLast4string | null RequiredThe last four characters of the previous signing secret, for recognizing it. Null together with previousSigningSecretExpiresAt.
createdAtstring (date-time) RequiredISO 8601 timestamp.
p50AttemptLatencyMsnumber | null RequiredMedian HTTP attempt latency in the last 24 hours. Null when nothing was attempted.
p95AttemptLatencyMsnumber | null Required95th percentile HTTP attempt latency in the last 24 hours, as a histogram bucket upper bound. Null when nothing was attempted.
lastFailureAtstring | null RequiredTime of the latest failed delivery attempt. Null when none failed.
lastFailureEventIdstring | null RequiredThe event whose delivery had the latest failed attempt.
lastFailureErrorstring | null RequiredFailure reason from the latest failed delivery attempt.
recentDeliveriesobject[] RequiredThe five newest deliveries for this destination.
Show child attributesHide child attributes
idstring RequiredA delivery ID, starting with dlv_.
eventIdstring RequiredAn event ID, starting with evt_.
eventTypestring RequiredThe type of the event this delivery carries.
statusstring Required“held”: the event arrived too late to deliver, and the delivery waits for you to resend it. “pending”: not attempted yet.
Allowed values: "pending", "held", "delivering", "retrying", "delivered", "failed"
attemptCountnumber RequiredAttempts recorded so far.
acceptedAtstring (date-time) RequiredISO 8601 timestamp.
completedAtstring | null RequiredWhen the delivery settled. Null while it is still live.
statusCodenumber | null RequiredHTTP status of the latest attempt. Null when no attempt got a response.
signingSecretstring | null RequiredThe full signing secret. Returned by Create a destination and Rotate a destination signing secret, and by Get a destination with include=secret. Null otherwise.
previousSigningSecretstring | null RequiredThe full previous signing secret, while it is still active. Returned by Get a destination with include=previous_secret. Null otherwise.
Example
curl -X DELETE "https://api.payloadpuffin.com/v1/destinations/$DESTINATIONID/record-settings" \
-H "Authorization: Bearer $PAYLOADPUFFIN_API_KEY"{
"data": {
"id": "id",
"name": "name",
"kind": "kind",
"url": "url",
"eventTypes": [
"eventTypes"
],
"channels": [
"channels"
],
"transformId": "transformId",
"enabled": true,
"keepTrying": true,
"retryPayloadRejections": true,
"autoPause": {
"pausedAt": "pausedAt",
"failureShare": 0,
"attempts": 0
},
"signingSecretLast4": "signingSecretLast4",
"health": "healthy",
"successRate24h": 0,
"attempts24h": 0,
"delivered24h": 0,
"failed24h": 0,
"lastDeliveryAt": "lastDeliveryAt",
"timeoutMs": 0,
"maxConcurrency": 0,
"rateLimitPerSecond": 0,
"rateLimitBurst": 0,
"usesDefaultDeliveryPolicy": true,
"storeRequests": true,
"storeResponses": true,
"cooldownUntil": "cooldownUntil",
"circuitState": "closed",
"circuitFailureCount": 0,
"circuitOpenUntil": "circuitOpenUntil",
"hasPreviousSigningSecret": true,
"previousSigningSecretExpiresAt": "previousSigningSecretExpiresAt",
"previousSigningSecretLast4": "previousSigningSecretLast4",
"createdAt": "createdAt",
"p50AttemptLatencyMs": 0,
"p95AttemptLatencyMs": 0,
"lastFailureAt": "lastFailureAt",
"lastFailureEventId": "lastFailureEventId",
"lastFailureError": "lastFailureError",
"recentDeliveries": [
{
"id": "id",
"eventId": "eventId",
"eventType": "eventType",
"status": "pending",
"attemptCount": 0,
"acceptedAt": "acceptedAt",
"completedAt": "completedAt",
"statusCode": 0
}
],
"signingSecret": "signingSecret",
"previousSigningSecret": "previousSigningSecret"
}
}Errors
Errors use application/problem+json. The code member is stable; branch on it rather than on title or detail.
4XXapplication/problem+jsonThe request was rejected.