O uso de webhooks e chamadas de API no flow é um recurso extremamente poderoso e que faz a Tayon se destacatar de outras plataformas por conta da versatilidade e capacidade de integração com praticamente qualquer outro sistema.
1 – A URL externa da API ou Webhook que deve ser chamada.
2 – O tipo de envio que a API ou Webhook espera. Pode ser POST ou GET.
3 – A lista de parâmetros que serão passados. Pode ser uma lista com um parâmetro por linha ou um JSON válido (detalhes mais adiante).
4 – Cabeçalhos (headers) para a chamada. Geralmente um token de autorização ou outro header exigido pela API/Webhook.
5 – Tipo de retorno que será salvo no IDENTIFICADOR para este webhook. O retorno pode ser um código HTTP (200, 404, 500, etc), um texto ou um JSON.
Exemplo de uma chamada completa:
Supondo que o código da API na URL https://api.oneapptointegrate.com seja algo parecido com esse:
<?php
// Set your secret token here
$secret_token = "thesecrettokenfortheapi";
// Get the authorization header
$headers = apache_request_headers();
if (!isset($headers['Authorization'])) {
http_response_code(401);
echo json_encode(["error" => "Unauthorized"]);
exit;
}
// Validate the bearer token
$authHeader = $headers['Authorization'];
list($token_type, $token) = explode(" ", $authHeader);
if ($token_type !== "Bearer" || $token !== $secret_token) {
http_response_code(403);
echo json_encode(["error" => "Forbidden"]);
exit;
}
// Retrieve POST data
$name = $_POST['name'] ?? null;
$phone = $_POST['phone'] ?? null;
$email = $_POST['email'] ?? null;
$address = $_POST['address'] ?? null;
// Validate that required data is present
if (!$name || !$phone || !$email || !$address) {
http_response_code(400);
echo json_encode(["error" => "Missing parameters"]);
exit;
}
// Return data as JSON
$response = [
"name" => $name,
"phone" => $phone,
"email" => $email,
"address" => $address,
];
header("Content-Type: application/json");
echo json_encode($response);
?>
O resultado será um JSON com os mesmos dados enviados. Parr recuperar os dados recebidos pelo webhook, basta usar o mesmo identificador como variável no flow. Quando se trata de um JSON, os dados pode ser recuperados com o formato IDENTIFICADOR[atributo]. Veja exemplo abaixo:
Quando estiver testando o seu flow, você pode recuperar os dados de retorno no painel seguinte ao da chamada do webhook e mostrar o conteúdo no painel. Assim você pode verificar se a chamada deu certo ou se houve algum erro, por exemplo.
Supondo que você faça uma chamada de webhook apenas para envio de dados e não precisa do retorno para o seu flow. Nesse caso, você pode colocar o retorno como código HTTP e no seu flow ter uma decisão logo após a ação do webhook que compara o retorno com 200. Se o retorno = 200, o webhook foi executado com sucesso. Se o retorno for diferente de 200 pode significar que houve um erro ou existe um problema nos parâmetros, autenticação, etc. Se precisar dos detalhes, você pode temporariamente mudar o retorno para “texto” e verificar o conteúdo. A maioria das APIs e Webhooks enviam uma mensagem no corpo da página de retorno com a descrição do resultado da chamada ou um JSON com esses detalhes. Nos dois casos, ao setar o retorno como “texto” você poderá exibir o conteúdo do identificador usado no webhook no painel seguinte e verificar o retorno.
Também é possível passar um JSON como parâmetro para a API/Webhook quando for necessário. Exemplo:
IMPORTANTE: O uso de webhooks e chamadas de API é um recurso avançado. Você deve conhecer os conceitos e saber o que está fazendo, caso contrário dados podem ser perdidos ou contas bloqueadas em outros apps. A Tayon não se responsabiliza pelo uso indevido de webhooks.