Skip to main content

Get / Update / Delete / Test

Get destination details, update config, delete a destination, or send a test payload to verify connectivity. Auth credentials are always redacted in responses.

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.
created_atstringISO 8601 creation timestamp.
updated_atstringISO 8601 last update timestamp.

Response

{
  "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "name": "Production Webhook",
  "type": "webhook",
  "config": { "url": "https://api.example.com/ingest" },
  "has_auth_config": false,
  "has_signing_secret": true,
  "payload_cap_bytes": null,
  "is_active": true,
  "last_delivery_at": "2024-09-15T11:00:00.000Z",
  "last_delivery_status": "succeeded",
  "created_at": "2024-09-01T10:00:00.000Z",
  "updated_at": "2024-09-01T10:00:00.000Z"
}

Errors

Error responses

401unauthorizedMissing or invalid API key.
404not_foundNo destination with this ID exists for your organization.
429rate_limitedToo many requests. Retry after the period indicated in the Retry-After header.
PUT/v1/delivery/destinations/:id

Response

Response fields

idstringDestination UUID.
namestringUpdated destination name.
typestringConnector type.
configobjectUpdated transport config.
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_activebooleanCurrent active status.
last_delivery_atstring | nullISO 8601 timestamp of the last delivery attempt.
last_delivery_statusstring | nullStatus of the last delivery attempt.
created_atstringISO 8601 creation timestamp.
updated_atstringISO 8601 last update timestamp.

Response

{
  "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "name": "Production Webhook (updated)",
  "type": "webhook",
  "config": { "url": "https://api.example.com/ingest-v2" },
  "has_auth_config": false,
  "has_signing_secret": true,
  "payload_cap_bytes": null,
  "is_active": true,
  "last_delivery_at": "2024-09-15T11:00:00.000Z",
  "last_delivery_status": "succeeded",
  "created_at": "2024-09-01T10:00:00.000Z",
  "updated_at": "2024-09-16T08:00:00.000Z"
}

Errors

Error responses

401unauthorizedMissing or invalid API key.
404not_foundNo destination with this ID exists for your organization.
429rate_limitedToo many requests. Retry after the period indicated in the Retry-After header.
DELETE/v1/delivery/destinations/:id

Response

Response fields

deletedbooleanAlways true on success.

Response

{
  "deleted": true
}

Errors

Error responses

401unauthorizedMissing or invalid API key.
404not_foundNo destination with this ID exists for your organization.
429rate_limitedToo many requests. Retry after the period indicated in the Retry-After header.
POST/v1/delivery/destinations/:id/test

Response

Response fields

successbooleanWhether the test delivery succeeded.
durationMsintegerRound-trip duration in milliseconds.
messagestring | nullOptional human-readable message (e.g. the bucket or folder that was probed).

Response

{
  "success": true,
  "durationMs": 142,
  "message": "bucket 'talonic-output' reachable"
}

Errors

Error responses

401unauthorizedMissing or invalid API key.
404not_foundNo destination with this ID exists for your organization.
429rate_limitedToo many requests. Retry after the period indicated in the Retry-After header.

Related

List Destinations