API de notificações

Envie mensagens automatizadas para reservas de eventos, simplifique suas operações e escale de forma eficaz.

A API de Notificações permite que você se integre com o Rapid API mais intimamente do que nunca. Quando ocorrerem alterações nas reservas que possam afetar seus negócios ou operações, a API de Notificações enviará os detalhes da alteração diretamente para todas as partes afetadas. As mensagens podem ser iniciadas por agentes, fornecedores e pelo próprio Rapid API. Isso significa que, se um atendente da central de atendimento fizer uma alteração ou um provedor cancelar uma reserva, você será notificado. Da mesma forma, se a API criar uma nova reserva com sucesso, você receberá uma notificação que poderá usar para manter o alinhamento com seus sistemas internos.

Nota: Na API de hospedagem, já oferecemos suporte a mensagens de agentes, fornecedores e do Rapid API. Nas APIs de Carros e Atividades, atualmente damos suporte a alterações de reserva em agent-initiated e em breve daremos suporte a alterações iniciadas em Rapid API e por nossos fornecedores.

A API de Notificações permite uma integração perfeita com o seu negócio e complementa outros serviços de suporte ao cliente e de parceiros. À medida que adicionamos recursos e funcionalidades ao Rapid API, também adicionaremos novos tipos de eventos de notificação para melhorar sua experiência.

Esquema e detalhes do evento

Todos os eventos de notificação POST seguem o esquema descrito abaixo. À medida que novos tipos de eventos são adicionados em eventos diferentes, o esquema sofre alterações.

Objeto	Descrição
`event_id`	Identificador único para cada evento.
`event_type`	Uma indicação de qual evento causou a notificação Este valor pode ser usado no tratamento e no roteamento da mensagem. Consulte a lista de tipos de evento para mais informações.
`event_time`	O registro de data e hora da notificação do evento, em UTC.
`itinerary_id`	O ID do itinerário da reserva afetada.
`email`	O e-mail do cliente associado ao itinerário afetado.
`message`	Informações sobre o evento de notificação. Para eventos do tipo `itinerary.message.received`, este campo conterá o texto real da mensagem do provedor. Em todos os outros tipos de eventos, serão uma descrição estática e de fácil compreensão do evento em inglês.
`affiliate_reference_id`	O número de referência do afiliado da reserva afetada.
`topic_tags`	As tags relativas ao tópico do evento. Elas aparecem apenas em eventos do tipo `itinerary.message.received`. Esta será uma lista de tags que nossa análise determinou que podem estar presentes no texto da mensagem. >> Saiba mais sobre as tags de mensagem propriedade
`line_of_business`	O ramo de atividade em que o evento se enquadra. Valores possíveis: `cars`, `flights`, `activities` e `packages` (`properties` será lançado em breve). Este campo não se aplica a todos os tipos de evento. Nota: Este campo está atualmente disponível para as APIs Rapid Car, Flight e Activities; a API Rapid Lodging ainda não o incorporou.
`file_name`	O campo file_name permite que o parceiro verifique se o arquivo correto foi anexado à conversa. Nota: Este campo só se aplica a anexos enviados através da API de Conversas.

Cada notificação é uma solicitação HTTPS POST com um corpo de mensagem JSON.

Nota: Você precisará habilitar cada tipo de evento individualmente para poder receber esses tipos de notificações. Se você quiser habilitar um novo tipo de evento de notificações, entre em contato com o suporte.

Tipos de eventos compatíveis

O serviço de Notificações Rápidas fornece mensagens proativas para os seguintes eventos. Os eventos suportados variam entre as linhas de negócio da Rapid.

API de hospedagem

Eventos suportados pela API de Hospedagem

A API Rapid Lodging suporta todos os seguintes eventos:

Valor do event_type	Origem	Evento	Detalhes
`itinerary.agent.create`	Agente de atendimento ao cliente ou Affiliate Voyager	Criação da reserva	Uma nova reserva foi criada por um agente de atendimento ao cliente da Rapid ou do Affiliate Voyager.
`itinerary.agent.change`	Agente de atendimento ao cliente ou Affiliate Voyager	Atualização de reserva	Uma reserva existente foi atualizada por um agente de atendimento ao cliente da Rapid ou do Affiliate Voyager.
`itinerary.agent.cancel`	Agente de atendimento ao cliente ou Affiliate Voyager	Cancelamento de reserva	Uma reserva existente foi cancelada por um agente de atendimento ao cliente da Rapid ou do Affiliate Voyager.
`itinerary.api.create`	Rapid API	Itinerário criado via API	Uma chamada com o código Rapid API criou com sucesso uma nova reserva. Observação: Originar chamadas via API ajuda a manter uma única fonte de verdade em todos os sistemas, reduzindo problemas como "reservas fantasmas".
`itinerary.api.create_failed`	Rapid API	A criação do itinerário via AP falhou.	Uma tentativa de criar uma reserva com o código Rapid API falhou definitivamente.
`itinerary.api.change`	Rapid API	Atualização de itinerário via API	Uma chamada Rapid API alterou uma reserva existente — seja uma alteração definitiva (como quarto, datas, pagamento) ou uma alteração opcional (como detalhes do hóspede).
`itinerary.api.cancel`	Rapid API	Itinerário cancelado via API	Uma chamada Rapid API cancelou a reserva.
`itinerary.fraud.cancel`	Expedia	Cancelamento de reserva	Uma reserva existente foi cancelada pela Expedia porque não estava em conformidade com os termos e condições da transação. O cliente precisa enviar uma mensagem a transactionprocessing@travelscape.com informando o número de telefone e o melhor horário para conversar sobre o cancelamento.
`itinerary.payment_verification.failure`	Propriedade	Link para alteração de pagamento com cartão de crédito	O cartão de pagamento fornecido pelo viajante no momento da reserva foi marcado como inválido pela Expedia após o código pre-authorization. >> Saiba mais sobre o recurso de Recuperação de Cartão de Crédito
`itinerary.supplier.cancel`	Propriedade	Cancelamento de reserva	Uma reserva existente foi cancelada pelo propriedade. O cliente deve entrar em contato com o serviço de atendimento ao cliente da sua empresa.
`itinerary.supplier.confirm`	Propriedade	Atualização de reserva	O propriedade atualizou o ID de confirmação da reserva.
`itinerary.supplier.change`	Propriedade	Atualização de reserva	Uma reserva existente foi alterada pelo propriedade devido à chegada tardia ou ao check-out antecipado do viajante.
`itinerary.supplier.refund`	Propriedade	Atualização de reserva	Para reservas feitas com o Expedia Collect, o código propriedade está oferecendo reembolsos solicitados pelos viajantes. É dever do parceiro garantir que o viajante receba os reembolsos.
`itinerary.traveler.noshow`	Propriedade	No show de viajante	O viajante não compareceu; portanto, o usuário propriedade marcou a reserva como "Não compareceu".
`itinerary.traveler.checked_in`	Propriedade	Viajante faz check-in em propriedade	O viajante fez o check-in no hotel propriedade, conforme registrado pelo provedor.
`itinerary.unspecified.cancel`	Expedia	Reserva cancelada por uma parte não especificada.	Esta notificação é enviada quando uma reserva é cancelada, mas o sistema não consegue identificar se o cancelamento foi iniciado pelo viajante, pelo anfitrião (propriedade/host) ou por um agente. É usado principalmente para reservas da Vrbo no código Rapid API, onde não é possível determinar quem cancelou a reserva, bem como para cancelamentos de itinerários de voos onde a parte é desconhecida. Como a origem do cancelamento é indeterminada, os parceiros não conseguem distinguir quem iniciou o cancelamento apenas com base na notificação.
`itinerary.unspecified.change`	Expedia	A reserva foi alterada por uma parte não especificada.	Esta notificação é enviada quando uma reserva existente é alterada (uma "alteração definitiva"), mas o sistema não consegue identificar se a alteração foi iniciada pelo viajante, pelo anfitrião (propriedade/host) ou por um agente. É usado principalmente para reservas do Vrbo em Rapid API. Ao receber esta notificação, os parceiros devem realizar uma chamada de Recuperação de Reserva para determinar o que foi alterado e visualizar os detalhes atualizados da reserva.
`itinerary.message.received`	Propriedade	Nova mensagem enviada	O usuário propriedade enviou uma nova mensagem através da Central de Mensagens (PMC) ou da API de Conversação. >> Saiba mais sobre nossas soluções de conversação.
`itinerary.message.rejected`	Parceiro de demanda / Viajante	Fraude ou phishing detectados	Uma mensagem enviada por um viajante ou agente parceiro sob demanda é suprimida por ser identificada como fraudulenta ou de natureza phishing. A mensagem foi bloqueada e não foi entregue.
`itinerary.conversation.attachment.success`	Parceiro de demanda / Viajante	Envio do anexo concluído com sucesso.	Um anexo enviado por um viajante ou agente parceiro sob demanda como parte de uma conversa foi carregado e adicionado à conversa com sucesso.
`itinerary.conversation.attachment.failure`	Parceiro de demanda / Viajante	Falha ao enviar o anexo	Um anexo enviado por um viajante ou agente parceiro sob demanda como parte de uma conversa foi carregado no bucket S3, mas não foi incluído na conversa.

Exemplo de itinerary.agent.create

{
     "event_id": "dbacce6c-afcb-4b23-ae66-48050757551c",
     "event_type": "itinerary.agent.create",
     "event_time": "2026-08-09T16:47:32.039Z",
     "itinerary_id": "8091234567890",
     "email": "customer@example.com",
     "message": "An agent created a new itinerary.",
     "affiliate_reference_id": "b086d299-2f1f-4134-a23c-f4a1c9286fac"
 }

Exemplo de itinerary.supplier.confirm

{
    "event_id": "e02d6f41-4708-476f-915d-8a7032942e94",
    "event_type": "itinerary.supplier.confirm",
    "event_time": "2027-04-28T20:31:03.423Z",
    "itinerary_id": "8999989898988",
    "email": "alice@example.com",
    "message": "The supplier confirmed one or more rooms on this itinerary.",
    "affiliate_reference_id": "R194193582",
    "rooms": [
        {
            "confirmation_id": {
                "expedia": "926784314",
                "property": "BEF23123AA"
            }
        },
        {
            "confirmation_id": {
                "expedia": "926784315"
            }
        }
    ]
}

Exemplo de itinerary.message.received

{
  "event_id": "1aed5641-7285-4c42-b079-f5f2f139d148",
  "event_type": "itinerary.message.received",
  "event_time": "2027-11-14T02:33:18.860105363Z",
  "itinerary_id": "9025254271673",
  "email": "john@email.com",
  "message": " We accept your request for a river view room. You will be able to check in at 11:00 AM. Please also note that the pool will be closed for scheduled maintenance on the day of your arrival, it will be open normal hours (9 AM to 10 PM) for the remainder of your stay. Looking forward to your visit.",
  "topic_tags": "Check-in, Property/Amenity Closure",
  "affiliate_reference_id": "b086d299-2f1f-4134-a23c-f4a1c9286fac"
}

Car API

Eventos suportados pela API de Carros

Neste momento, a API Rapid Car suporta apenas um tipo de notificação: o cancelamento de uma reserva. Outros eventos estão sendo adicionados. Iremos listá-los aqui quando estiverem disponíveis.

Valor do event_type	Origem	Evento	Detalhes
`itinerary.agent.cancel`	Agente de atendimento ao cliente ou Affiliate Voyager	Cancelamento de reserva	Uma reserva existente foi cancelada por um agente de atendimento ao cliente da Rapid ou do Affiliate Voyager.

API de Atividades

Eventos suportados pela API de Atividades

Neste momento, a API de Atividades Rápidas suporta dois tipos de eventos de notificação. Outros eventos estão sendo adicionados. Iremos listá-los aqui quando estiverem disponíveis.

Valor do event_type	Origem	Evento	Detalhes
`itinerary.agent.cancel`	Agente de atendimento ao cliente ou Affiliate Voyager	Cancelamento de reserva	Uma reserva existente foi cancelada por um agente de atendimento ao cliente da Rapid ou do Affiliate Voyager.
`itinerary.supplier.cancel`	Fornecedor	Cancelamento de reserva	Uma reserva existente foi cancelada pelo provedor. O cliente deve entrar em contato com o serviço de atendimento ao cliente da sua empresa.

Detalhes da API

Explore as definições dos pontos de extremidade relacionados a notificações nesta página e use o API Explorer ou outro software de teste para comparar os exemplos e as definições de esquemas com o resultado real. Também temos um Testador de Notificações que você pode usar para testar sua integração com nossa API de Notificações.