Skip to content
pipeo
Menu

Admin API

Destinations

Create destinations, update their settings and run connection tests.

A destination is one configured delivery target of one adapter type: webhook, GA4, Mixpanel or the S3 file sink. Secret settings are sealed to the worker's public key and never returned.

A connection test sends test messages with the real settings and stores the outcome, so you can check a destination before it receives live traffic.

Operations

OperationRequestWho may call it
listDestinationsGET /v1/workspaces/{ws}/destinationsviewer or above; staff: super, support
createDestinationPOST /v1/workspaces/{ws}/destinationseditor or above
testDestinationPOST /v1/workspaces/{ws}/destinations/testeditor or above
getDestinationTestGET /v1/workspaces/{ws}/destinations/test/{probeId}editor or above
deleteDestinationDELETE /v1/workspaces/{ws}/destinations/{id}admin
getDestinationGET /v1/workspaces/{ws}/destinations/{id}viewer or above; staff: super, support
updateDestinationPATCH /v1/workspaces/{ws}/destinations/{id}editor or above
listDestinationTestsGET /v1/workspaces/{ws}/destinations/{id}/testseditor or above

This is the console’s API, not a public one: requests reach it only through the console’s server, for a signed-in user. There are no API keys for it yet. It is listed so you know what each action does and which role it needs.