Skip to main content
PATCH
Set Flow endpoint destination (alias of PUT)

Authorizations

x-api-key
string
header
required

Your ps_ API key

Path Parameters

id
string
required

The local id of the Flow — the id field GET /v1/flows returns, never metaFlowId.

Body

application/json
url
string
required

The customer's own https:// webhook. null CLEARS the destination and keeps the signing secret. Required — omitting the field is 400 FLOW_ENDPOINT_URL_REQUIRED, never a wipe.

Example:

"https://hooks.acme.com/flows/data-exchange"

rotateSecret
boolean

Mints a new HMAC signing secret and returns it once. Must be a real boolean — "true" is refused, never coerced (400 FLOW_ENDPOINT_ROTATE_INVALID).

Example:

false

Response

Destination stored. secret is present ONLY when this request minted one — a rotation, or the first save on this Flow