Entrega disparada por API
Campanhas disparadas por API ou campanhas disparadas por servidor são ideais para casos de uso transacionais mais avançados. As campanhas disparadas por API da Braze permitem que profissionais de marketing gerenciem o texto da campanha, testes multivariantes e regras de reelegibilidade dentro do dashboard da Braze, enquanto disparam a entrega desse conteúdo a partir de seus próprios servidores e sistemas. A requisição de API para disparar a mensagem também pode incluir dados adicionais para serem inseridos na mensagem em tempo real por meio de templates.
Configurando uma Campaign disparada por API
Configurar uma Campaign disparada por API requer algumas etapas. Primeiro, crie uma nova Campaign multicanal ou de canal único (com testes multivariantes).
Em seguida, configure seu texto e notificações da mesma forma que faria normalmente para notificações agendadas e selecione API-Triggered Delivery. Para saber mais sobre como disparar essas Campaigns a partir do seu servidor, confira este artigo sobre envio de Campaigns disparadas por API.
Reduzindo a postergação entre o disparo da API e o envio
Se as mensagens demoram mais do que o esperado para serem enviadas após você chamar o endpoint de disparo, verifique se o perfil de usuário já está pronto no momento do disparo.
Por padrão, send_to_existing_only é true em /campaigns/trigger/send. A Braze envia apenas para usuários existentes e não cria perfis novos nessa chamada. Para criar ou atualizar um usuário e enviar na mesma requisição, defina send_to_existing_only como false e inclua um objeto attributes em cada destinatário.
Para Campaigns de e-mail, inclua também email (e quaisquer outros campos de entrega obrigatórios) dentro de attributes. Se o perfil não tiver um endereço de e-mail quando você disparar o envio, a Braze faz novas tentativas por aproximadamente 2 horas enquanto aguarda a chegada dos dados do perfil. Incluir email na mesma chamada evita essa postergação.
Para ver todos os parâmetros de requisição, exemplos e comportamento de novas tentativas, consulte Enviar Campaigns disparadas por API e o objeto de destinatários.
Essa orientação se aplica a Campaigns disparadas por API (/campaigns/trigger/send). O endpoint de e-mail de transação usa um formato de requisição diferente (recipient, singular) e não oferece suporte a send_to_existing_only. Para criar um usuário inline com envios de transação, passe attributes no objeto recipient.
Usando o conteúdo modelado incluído em uma solicitação de API
Além de disparar a mensagem, você também pode incluir conteúdo na solicitação de API para ser modelado na mensagem dentro do objeto trigger_properties. Esse conteúdo pode ser referenciado no corpo da mensagem.
Use exatamente duas chaves por Liquid tag em trigger_properties e no texto da mensagem. Um exemplo é: {{api_trigger_properties.${your_property}}}. Um { ou } extra é uma causa comum de falhas de personalização disparadas por API.
Veja o exemplo de notificação social a seguir para mais contexto.
Reelegibilidade com Campaigns disparadas por API
O número de vezes que um usuário recebe uma Campaign disparada por API pode ser limitado usando as configurações de reelegibilidade. Isso significa que o usuário recebe a Campaign apenas uma vez ou uma vez dentro de um determinado período, independentemente de quantas vezes o disparo da API é acionado.
Por exemplo, digamos que você esteja usando uma Campaign disparada por API para enviar ao usuário uma Campaign sobre um item que ele visualizou recentemente. Nesse caso, você pode limitar a Campaign para enviar no máximo uma mensagem por dia, independentemente de quantos itens ele visualizou, enquanto dispara o gatilho da API para cada item. Se a sua Campaign disparada por API for de transação, certifique-se de que o usuário receba a Campaign toda vez que realizar a transação, definindo a postergação como zero minutos.
