Flows

Set Flow endpoint destination

Stores the customer’s OWN webhook — the destination we forward each decrypted Flow exchange to. This does NOT touch Meta. Registering endpoint_uri on the Flow is a separate act against a separate system (POST on this same resource); doing it here would silently re-point the Flow of a tenant who already runs their own endpoint, on a request that looked like a rename. What this answers instead is where Meta IS pointing — metaEndpointUri, drift and warnings.

⛔ url must be https://. The body forwarded to it is the END USER’s form answers, decrypted by us out of Meta’s envelope one hop earlier; over http:// that is PII in the clear, and there is no flag that allows it (400 FLOW_ENDPOINT_URL_NOT_HTTPS). The refused URL is not echoed back — it may carry a token in its query string.

⚠️ url is REQUIRED and may be null EXPLICITLY, never by omission. An absent field and a null one mean opposite things — “I sent you a partial body” and “remove the destination” — so an omitted url is 400 FLOW_ENDPOINT_URL_REQUIRED rather than a wipe of a working configuration. "url": null CLEARS the destination and KEEPS the secret; rotateSecret: true is the exit for a secret that leaked.

⚠️ secret comes back on exactly ONE response in the life of a secret: the request that minted it. It is encrypted at rest and there is no read path back, so secret: null means “one already existed and was kept”, not “there is none” — hasSecret answers that.

A truncated body is not read as an empty one: {"url": "https://x" (one missing brace) is 400 FLOW_BODY_INVALID. Only url and rotateSecret are accepted; the number comes from the KEY, so naming it in the body is 400 FLOW_NUMBER_FROM_KEY. Permission flows:manage.

Requires a number-scoped key. A tenant-scoped key must name the number with the x-whatsapp-number-id header, or it gets 403 TENANT_SCOPE_NOT_ALLOWED.

PUT

flows

{id}

endpoint

Set Flow endpoint destination

curl --request PUT \
  --url https://pilotstatus.com.br/v1/flows/{id}/endpoint \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "url": "https://hooks.acme.com/flows/data-exchange"
}
'

import requests

url = "https://pilotstatus.com.br/v1/flows/{id}/endpoint"

payload = { "url": "https://hooks.acme.com/flows/data-exchange" }
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({url: 'https://hooks.acme.com/flows/data-exchange'})
};

fetch('https://pilotstatus.com.br/v1/flows/{id}/endpoint', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://pilotstatus.com.br/v1/flows/{id}/endpoint",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'url' => 'https://hooks.acme.com/flows/data-exchange'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://pilotstatus.com.br/v1/flows/{id}/endpoint"

	payload := strings.NewReader("{\n  \"url\": \"https://hooks.acme.com/flows/data-exchange\"\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("x-api-key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.put("https://pilotstatus.com.br/v1/flows/{id}/endpoint")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"url\": \"https://hooks.acme.com/flows/data-exchange\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://pilotstatus.com.br/v1/flows/{id}/endpoint")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"url\": \"https://hooks.acme.com/flows/data-exchange\"\n}"

response = http.request(request)
puts response.read_body

{
  "flowId": "cmf1a2b3c4d5e6f7g8h9i0j1",
  "url": "https://hooks.acme.com/flows/data-exchange",
  "hasSecret": true,
  "endpointUri": "https://pilotstatus.com.br/api/flows/endpoint/AbC123.../1122334455",
  "metaEndpointUri": "https://pilotstatus.com.br/api/flows/endpoint/AbC123.../1122334455",
  "drift": false,
  "numberHasKey": true,
  "numberKeyUploadedAt": "2026-09-01T18:04:00.000Z",
  "warnings": [],
  "secret": "9f8a1c0e7b6d5a4c3e2f1b0a9d8c7e6f5a4b3c2d1e0f9a8b7c6d5e4f3a2b1c0d"
}

{
  "error": "url é obrigatório: envie a URL https:// do seu webhook, ou `\"url\": null` para deixar este Flow sem destino.",
  "errorEN": "url is required: send your webhook's https:// URL, or `\"url\": null` to leave this Flow with no destination.",
  "code": "FLOW_ENDPOINT_URL_REQUIRED"
}

{
  "error": "Unauthorized"
}

{
  "error": "Tenant-scoped keys cannot call number endpoints",
  "code": "TENANT_SCOPE_NOT_ALLOWED"
}

{
  "error": "Flow não encontrado para o número desta chave.",
  "errorEN": "Flow not found for this key's number.",
  "code": "FLOW_NOT_FOUND"
}

{
  "error": "Flows existem apenas em números Meta (API Oficial). O número desta chave não é Meta ou não tem uma WABA associada — use uma chave de um número Meta.",
  "errorEN": "Flows only exist on Meta (Cloud API) numbers. This key's number is not a Meta number, or has no WABA behind it — use a key bound to a Meta number.",
  "code": "FLOW_REQUIRES_META_NUMBER"
}

{
  "error": "Too many requests"
}

{
  "error": "Não foi possível guardar o segredo de assinatura deste endpoint: o serviço não está configurado para armazená-lo com segurança. Fale com o suporte.",
  "errorEN": "Could not store this endpoint's signing secret: the service is not configured to keep it safely. Contact support.",
  "code": "FLOW_ENDPOINT_SECRET_UNAVAILABLE"
}

Authorizations

x-api-key

string

header

required

Your ps_ API key

Path Parameters

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

Set Flow endpoint destination

curl --request PUT \
  --url https://pilotstatus.com.br/v1/flows/{id}/endpoint \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "url": "https://hooks.acme.com/flows/data-exchange"
}
'

import requests

url = "https://pilotstatus.com.br/v1/flows/{id}/endpoint"

payload = { "url": "https://hooks.acme.com/flows/data-exchange" }
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({url: 'https://hooks.acme.com/flows/data-exchange'})
};

fetch('https://pilotstatus.com.br/v1/flows/{id}/endpoint', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://pilotstatus.com.br/v1/flows/{id}/endpoint",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'url' => 'https://hooks.acme.com/flows/data-exchange'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://pilotstatus.com.br/v1/flows/{id}/endpoint"

	payload := strings.NewReader("{\n  \"url\": \"https://hooks.acme.com/flows/data-exchange\"\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("x-api-key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.put("https://pilotstatus.com.br/v1/flows/{id}/endpoint")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"url\": \"https://hooks.acme.com/flows/data-exchange\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://pilotstatus.com.br/v1/flows/{id}/endpoint")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"url\": \"https://hooks.acme.com/flows/data-exchange\"\n}"

response = http.request(request)
puts response.read_body

{
  "flowId": "cmf1a2b3c4d5e6f7g8h9i0j1",
  "url": "https://hooks.acme.com/flows/data-exchange",
  "hasSecret": true,
  "endpointUri": "https://pilotstatus.com.br/api/flows/endpoint/AbC123.../1122334455",
  "metaEndpointUri": "https://pilotstatus.com.br/api/flows/endpoint/AbC123.../1122334455",
  "drift": false,
  "numberHasKey": true,
  "numberKeyUploadedAt": "2026-09-01T18:04:00.000Z",
  "warnings": [],
  "secret": "9f8a1c0e7b6d5a4c3e2f1b0a9d8c7e6f5a4b3c2d1e0f9a8b7c6d5e4f3a2b1c0d"
}

{
  "error": "url é obrigatório: envie a URL https:// do seu webhook, ou `\"url\": null` para deixar este Flow sem destino.",
  "errorEN": "url is required: send your webhook's https:// URL, or `\"url\": null` to leave this Flow with no destination.",
  "code": "FLOW_ENDPOINT_URL_REQUIRED"
}

{
  "error": "Unauthorized"
}

{
  "error": "Tenant-scoped keys cannot call number endpoints",
  "code": "TENANT_SCOPE_NOT_ALLOWED"
}

{
  "error": "Flow não encontrado para o número desta chave.",
  "errorEN": "Flow not found for this key's number.",
  "code": "FLOW_NOT_FOUND"
}

{
  "error": "Flows existem apenas em números Meta (API Oficial). O número desta chave não é Meta ou não tem uma WABA associada — use uma chave de um número Meta.",
  "errorEN": "Flows only exist on Meta (Cloud API) numbers. This key's number is not a Meta number, or has no WABA behind it — use a key bound to a Meta number.",
  "code": "FLOW_REQUIRES_META_NUMBER"
}

{
  "error": "Too many requests"
}

{
  "error": "Não foi possível guardar o segredo de assinatura deste endpoint: o serviço não está configurado para armazená-lo com segurança. Fale com o suporte.",
  "errorEN": "Could not store this endpoint's signing secret: the service is not configured to keep it safely. Contact support.",
  "code": "FLOW_ENDPOINT_SECRET_UNAVAILABLE"
}

Endpoints

Workspace

Set Flow endpoint destination

Authorizations

Path Parameters

Body

Response