Get destination details, update config, delete a destination, or send a test payload to verify connectivity. Auth credentials are always redacted in responses.
Manage a single destination: retrieve its current config, update transport settings or credentials, delete it, or test connectivity. The test endpoint probes the destination without delivering real data — file-drop connectors (S3, SFTP, Azure Blob) verify bucket/container reachability without writing any objects.
Use GET to inspect current config and delivery status. Use PUT to rotate credentials or change the target URL/bucket. Use POST /test after updating credentials to verify the new config works before live traffic flows through it. Use DELETE only when permanently removing a destination.
The GET response includes last_delivery_at and last_delivery_status to show the most recent delivery attempt. The is_active flag indicates whether the destination is enabled — destinations are automatically disabled on auth_failed or ssrf_blocked errors. The test endpoint returns success, durationMs, and an optional message describing what was probed.
If a destination becomes inactive due to auth failure, fix the credentials via PUT, then call the test endpoint to verify. The destination will be re-enabled automatically on a successful update. Prefer disabling (is_active: false via PUT) over deleting when you want to pause delivery but keep the history.
Deleting a destination removes its delivery items and DLQ entries irreversibly. Bindings routed to it are kept but orphaned: deactivated, marked last_status: destination_deleted, with destination_id: null — re-point them via PUT /v1/delivery/bindings/:id and re-enable. Disable the destination (is_active: false) instead if you want to preserve history.
GET/v1/delivery/destinations/:id
Response
Response fields
idstringDestination UUID.
namestringDestination name.
typestringConnector type.
configobjectTransport config. Auth credentials are never returned.
has_auth_configbooleanWhether auth credentials are configured.
has_signing_secretbooleanWhether an HMAC signing secret is configured.
payload_cap_bytesinteger | nullPer-destination payload cap override.
is_activebooleanWhether the destination is enabled.
last_delivery_atstring | nullISO 8601 timestamp of the last delivery attempt.
last_delivery_statusstring | nullStatus of the last delivery attempt.
404not_foundNo destination with this ID exists for your organization.
429rate_limitedToo many requests. Retry after the period indicated in the Retry-After header.
Frequently asked questions
Does the test endpoint write data to the destination?+−
No. File-drop connectors (S3, SFTP, Azure Blob, Google Drive, OneDrive) use lightweight probes (HeadBucket, list, getProperties) that verify reachability without creating any objects. Webhook destinations receive a small synthetic payload.
Can I re-enable a destination that was auto-disabled?+−
Yes. Fix the underlying issue (expired credentials, unreachable URL), then update the destination with the corrected config. The destination will be re-enabled automatically, or you can explicitly set is_active: true.
Should I disable or delete a destination I no longer use?+−
Disable it (is_active: false via PUT) if you want to preserve its bindings and delivery history. Deleting a destination cascades to all its bindings, delivery items, and DLQ entries, and is irreversible.