Flows

Ver config do endpoint do Flow

A ligação data_exchange de UM Flow: para onde reencaminhamos a troca decifrada (url), se existe segredo de assinatura (hasSecret), a NOSSA URL de proxy para este Flow (endpointUri), o que a Meta tem registado (metaEndpointUri), se os dois DIVERGEM (drift) e se o número tem sequer um par de chaves de cifra (numberHasKey).

⭐ numberHasKey: false é o campo pelo qual esta rota existe. Sem par de chaves no número a Meta não tem com que cifrar, portanto a chamada nunca chega ao proxy, portanto o destino nunca é usado — e mais nada, de nenhum dos lados, reporta isso. warnings leva os mesmos factos como códigos estáveis: FLOW_ENDPOINT_NO_DESTINATION, FLOW_ENDPOINT_NUMBER_HAS_NO_KEY, FLOW_ENDPOINT_KEY_NOT_AT_META, FLOW_ENDPOINT_META_URI_UNKNOWN, FLOW_ENDPOINT_META_DRIFT.

O segredo HMAC em si NUNCA é devolvido aqui — só hasSecret. Permissão flows:manage, e deliberadamente não flows:read: endpointUri e metaEndpointUri embutem o token de caminho do endpoint do número, e esse token é a credencial do proxy.

Exige chave com escopo de número. Uma chave de tenant precisa nomear o número no header x-whatsapp-number-id, senão recebe 403 TENANT_SCOPE_NOT_ALLOWED.

GET

flows

{id}

endpoint

Ver config do endpoint do Flow

curl --request GET \
  --url https://pilotstatus.com.br/v1/flows/{id}/endpoint \
  --header 'x-api-key: <api-key>'

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

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 => "GET",
  CURLOPT_HTTPHEADER => [
    "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"
	"net/http"
	"io"
)

func main() {

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

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<api-key>")

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

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

	fmt.Println(string(body))

}

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::Get.new(url)
request["x-api-key"] = '<api-key>'

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": []
}

{
  "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": "Erro interno do servidor.",
  "errorEN": "Internal server error.",
  "code": "INTERNAL_ERROR"
}

Autorizações

x-api-key

string

header

obrigatório

Sua chave de API ps_

Parâmetros de caminho

string

obrigatório

O id local do Flow — o campo id que GET /v1/flows devolve, nunca o metaFlowId.

Resposta

A ligação atual do endpoint data_exchange deste Flow

Ver config do endpoint do Flow

curl --request GET \
  --url https://pilotstatus.com.br/v1/flows/{id}/endpoint \
  --header 'x-api-key: <api-key>'

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

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 => "GET",
  CURLOPT_HTTPHEADER => [
    "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"
	"net/http"
	"io"
)

func main() {

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

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<api-key>")

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

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

	fmt.Println(string(body))

}

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::Get.new(url)
request["x-api-key"] = '<api-key>'

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": []
}

{
  "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": "Erro interno do servidor.",
  "errorEN": "Internal server error.",
  "code": "INTERNAL_ERROR"
}

Endpoints

Workspace

Ver config do endpoint do Flow

Autorizações

Parâmetros de caminho

Resposta