Flows

Registar o endpoint do Flow na Meta

Regista o NOSSO proxy como endpoint_uri deste Flow na Meta — o ato deliberado que o PUT neste mesmo recurso se recusa a fazer. Sem isto o data_exchange é inalcançável: a Meta recusa publicar um Flow cujo modelo de routing precisa de endpoint, com “Publishing without specifying ‘endpoint_uri’ is forbidden”.

⛔ É um verbo diferente e não um efeito colateral do PUT porque os dois atos têm sujeitos diferentes. Guardar um destino é o tenant a descrever o webhook DELE; isto é nós a dizer à META para encaminhar o Flow por nós. Fundir os dois faria com que um tenant que corre o próprio endpoint de Flow perdesse todas as trocas na próxima vez que corrigisse uma gralha numa URL.

⚠️ O corpo é OPCIONAL — ao contrário do PUT, este verbo não tem campo obrigatório, portanto sem corpo, string vazia e {} são todos aceites. Um corpo truncado continua a ser recusado (400 FLOW_BODY_INVALID), e confirmOverwrite é o único campo aceite.

⛔ confirmOverwrite não é formalidade. O endpoint_uri atual é lido AO VIVO do Graph — não de metaEndpointUri, que uma sincronia horária escreve e que por isso está muda sobre um URI registado na última hora. Se o Flow já aponta para outro sítio, registar leva TODAS as trocas de quem responde hoje, por isso o padrão é 409 FLOW_ENDPOINT_URI_WOULD_OVERWRITE — cujo corpo traz um QUARTO campo de topo, currentEndpointUri, nomeando o endpoint que seria deslocado. O nosso nunca é ecoado: embute o token de caminho do endpoint do número. Um não-booleano é recusado e nunca convertido (400 FLOW_ENDPOINT_CONFIRM_INVALID), porque "false" lido como verdadeiro assumiria um endpoint vivo num pedido cujo autor acreditava ter recusado.

Idempotente: um Flow que já aponta para nós responde 200 sem escrita no Graph, e metaEndpointUri é atualizado de qualquer forma. Um número sem par de chaves de endpoint é recusado com 422 FLOW_ENDPOINT_NUMBER_HAS_NO_KEY — registar mesmo assim diz à Meta para cifrar para um par de chaves que não existe, e todas as trocas do Flow publicado dariam 421. Permissão flows:manage.

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.

POST

flows

{id}

endpoint

Registar o endpoint do Flow na Meta

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

import requests

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

payload = { "confirmOverwrite": True }
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({confirmOverwrite: true})
};

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 => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'confirmOverwrite' => true
  ]),
  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  \"confirmOverwrite\": true\n}")

	req, _ := http.NewRequest("POST", 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.post("https://pilotstatus.com.br/v1/flows/{id}/endpoint")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"confirmOverwrite\": true\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::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"confirmOverwrite\": true\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": []
}

{
  "error": "confirmOverwrite deve ser um booleano (true ou false).",
  "errorEN": "confirmOverwrite must be a boolean (true or false).",
  "code": "FLOW_ENDPOINT_CONFIRM_INVALID"
}

{
  "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": "A Meta já aponta este Flow para outro endpoint. Registar o nosso passaria TODAS as trocas deste Flow para a Pilot Status. Reenvie com confirmOverwrite para assumir.",
  "errorEN": "Meta already points this Flow at another endpoint. Registering ours would take EVERY exchange of this Flow over to Pilot Status. Re-send with confirmOverwrite to take it over.",
  "code": "FLOW_ENDPOINT_URI_WOULD_OVERWRITE",
  "currentEndpointUri": "https://flows.acme.com/data-exchange"
}

{
  "error": "Este número ainda não tem chave de endpoint de Flow, por isso não existe URL para registar na Meta. Gere a chave do número primeiro.",
  "errorEN": "This number has no Flow endpoint key yet, so there is no URL to register at Meta. Generate the number's key first.",
  "code": "FLOW_ENDPOINT_NUMBER_HAS_NO_KEY"
}

{
  "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.

Corpo

application/json

confirmOverwrite

boolean

Consentimento para deslocar um endpoint_uri que não é nosso. Tem de ser um booleano de verdade — a string "false" é recusada, nunca convertida. Desnecessário quando a Meta não tem endpoint_uri, ou já tem o nosso.

Exemplo:

true

Resposta

A Meta passa a apontar este Flow para o nosso proxy. metaEndpointUri é atualizado a partir do que acabou de ser escrito, não do espelho horário. Sem secret: registar não cunha nada

Registar o endpoint do Flow na Meta

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

import requests

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

payload = { "confirmOverwrite": True }
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({confirmOverwrite: true})
};

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 => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'confirmOverwrite' => true
  ]),
  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  \"confirmOverwrite\": true\n}")

	req, _ := http.NewRequest("POST", 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.post("https://pilotstatus.com.br/v1/flows/{id}/endpoint")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"confirmOverwrite\": true\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::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"confirmOverwrite\": true\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": []
}

{
  "error": "confirmOverwrite deve ser um booleano (true ou false).",
  "errorEN": "confirmOverwrite must be a boolean (true or false).",
  "code": "FLOW_ENDPOINT_CONFIRM_INVALID"
}

{
  "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": "A Meta já aponta este Flow para outro endpoint. Registar o nosso passaria TODAS as trocas deste Flow para a Pilot Status. Reenvie com confirmOverwrite para assumir.",
  "errorEN": "Meta already points this Flow at another endpoint. Registering ours would take EVERY exchange of this Flow over to Pilot Status. Re-send with confirmOverwrite to take it over.",
  "code": "FLOW_ENDPOINT_URI_WOULD_OVERWRITE",
  "currentEndpointUri": "https://flows.acme.com/data-exchange"
}

{
  "error": "Este número ainda não tem chave de endpoint de Flow, por isso não existe URL para registar na Meta. Gere a chave do número primeiro.",
  "errorEN": "This number has no Flow endpoint key yet, so there is no URL to register at Meta. Generate the number's key first.",
  "code": "FLOW_ENDPOINT_NUMBER_HAS_NO_KEY"
}

{
  "error": "Too many requests"
}

{
  "error": "Erro interno do servidor.",
  "errorEN": "Internal server error.",
  "code": "INTERNAL_ERROR"
}

Endpoints

Workspace

Registar o endpoint do Flow na Meta

Autorizações

Parâmetros de caminho

Corpo

Resposta