Webhook: integração em segundos
O que são webhooks?
Webhooks são eventos disparados quando acontece uma alteração importante em uma transação. Com eles, você cria rotinas e fluxos de trabalho a partir do recebimento passivo de informações, sem precisar consultar a API o tempo todo.
Sempre que houver uma atualização, o sistema envia uma requisição para a URL configurada com os dados da transação atualizada, e o seu fluxo de trabalho pode seguir automaticamente.
Configuração
Para configurar o webhook, peça ao seu Consolidador / Operadora ou ao responsável pelo portal que adicione a URL de notificação nas configurações da sua credencial TravelLinkApi_Sales:
Painel › Travellink Api › Credenciais › Notification Url
A notificação é enviada para todas as credenciais cadastradas, de acordo com o contexto da transação.
Payload
O sistema envia um POST para a URL configurada com o seguinte objeto:
{
"Api": "Travellink-ApiSales",
"TransactionType": 2,
"TransactionTypeDescription": "Hotel",
"Id": 12050,
"UniqueId": "HTL-CE569F58-962A-4B3C-9320-A269AE8AF5B2",
"Locator": "PV_HTL-67AC9A90D5",
"Ticket": "",
"LastUpdate": "11/11/2022 14:57:17"
}
| Campo | Descrição |
|---|---|
Api | Origem da notificação (Travellink-ApiSales). |
TransactionType / TransactionTypeDescription | Tipo da transação. Veja Enums. |
Id | Identificador numérico interno. |
UniqueId | Identificador único da transação, que pode ser usado diretamente no Details. |
Locator | Localizador. |
Ticket | Número do bilhete (quando houver). |
LastUpdate | Data / hora da última atualização. |
Como combinar com o fluxo recomendado
O webhook complementa o fluxo recomendado e não o substitui:
- Use a notificação como gatilho para executar o ciclo
List → Details → Change, em vez de consultar oListcom muita frequência. - Ou processe diretamente o
UniqueIdrecebido (Detailse, em seguida,ChangecomImportState = 2). - Mantenha uma rotina periódica com o
List(FilterImportState = 1) como rede de segurança, para recuperar eventuais notificações perdidas.