Entrada baseada em API
A entrada baseada em API permite que você inicie uma jornada do cliente no momento em que um evento de negócio específico ocorre. Para iniciar uma campanha, você precisa enviar uma solicitação de API especial.
Aqui estão alguns casos de uso para uma entrada baseada em API:
- Informar os clientes quando os produtos estiverem de volta ao estoque
- Dizer aos usuários que o preço de um produto popular diminuiu
- Notificar os assinantes quando um novo episódio de podcast for lançado
Diferente dos Eventos regulares, todos esses eventos de negócio podem ocorrer fora do aplicativo. Por exemplo, a disponibilidade de um produto só pode ser verificada em um banco de dados externo. É aqui que uma entrada baseada em API se torna útil: você pode configurar o envio de uma solicitação para iniciar uma jornada sempre que certas alterações ocorrerem fora do aplicativo (por exemplo, em seu banco de dados externo).
Funciona da seguinte forma:
- Crie uma jornada com uma entrada baseada em API. Nas configurações de entrada, você encontrará o modelo da solicitação que inicia a jornada.
- Adicione condições de segmentação à solicitação usando a Linguagem de Segmentação. Você também pode adicionar placeholders de conteúdo à solicitação para alterar o conteúdo da mensagem dependendo do contexto.
- Automatize a solicitação, se necessário. Por exemplo, informações sobre uma mudança de preço podem ser enviadas imediatamente do banco de dados para o webhook. Assim que isso acontecer, o webhook deve enviar automaticamente a solicitação para iniciar a jornada. Você também pode enviar a solicitação manualmente se não precisar de automação.
Você pode enviar a solicitação um número ilimitado de vezes para alterar as condições de segmentação ou o conteúdo da mensagem.
Para mais detalhes, siga as instruções abaixo.
Configurar uma jornada com entrada baseada em API
Anchor link to- Crie uma jornada com uma entrada baseada em API:
-
Clique duas vezes na etapa de entrada baseada em API. A janela de configuração de entrada será aberta.
-
Você pode modificar o conteúdo de push e e-mail toda vez que a jornada for iniciada usando placeholders de conteúdo. O valor de cada placeholder pode ser alterado na solicitação. Se você não precisar desta opção, pode pular esta etapa.
Por exemplo, você está criando uma jornada para notificar os assinantes quando um novo episódio de podcast for lançado. Usando um placeholder de conteúdo, você pode alterar o título do podcast toda vez que iniciar a jornada.
Primeiro, adicione os nomes dos placeholders na janela de configuração de entrada baseada em API. Você pode usar quaisquer nomes que sejam convenientes para você.
Agora, crie uma predefinição de push ou conteúdo de e-mail e insira o placeholder no lugar do texto que você deseja modificar. O placeholder deve estar em um dos seguintes formatos, dependendo de suas necessidades:
{placeholder_name|format_modifier|}– se o valor do placeholder não for especificado ao iniciar a campanha, os usuários verão um espaço em branco em seu lugar.{placeholder_name|format_modifier}– se o valor do placeholder não for especificado e ainda não tiver sido atribuído a um usuário (caso você tenha usado uma Tag como placeholder), a mensagem não será enviada.
Modificadores de formato
- CapitalizeFirst – coloca em maiúscula a primeira letra do valor de um placeholder
- CapitalizeAllFirst – coloca em maiúscula as primeiras letras de todas as palavras no valor de um placeholder
- UPPERCASE – converte todas as letras para maiúsculas
- lowercase – converte todas as letras para minúsculas
- regular – insere o valor de um placeholder exatamente como especificado na solicitação
Ao configurar o elemento Push ou Email em sua jornada, selecione a predefinição criada e ative a opção Personalizar mensagem com atributos de evento.
Selecione os placeholders que você deseja modificar na solicitação ao iniciar a jornada. Escolha a Entrada baseada em API como a fonte e o nome do placeholder como o atributo dinâmico:
Clique em Aplicar para salvar as alterações.
- Na janela de configuração de entrada, copie o modelo de solicitação para modificá-lo:
- Adicione filtros de público ao parâmetro
"filter"usando a Linguagem de Segmentação ou copie a lógica de segmentação de seus segmentos. Configure as Tags necessárias com antecedência.
Por exemplo, para segmentar usuários que adicionaram o item Meias à sua Lista de Desejos, o valor de "filter" deve ser assim:
"filter": "A(\"12345-12345\") * "T(\"Wishlist\", EQ, \"Socks\")"
Neste exemplo, você deve ter uma Tag Wishlist configurada em seu aplicativo.
- Se você configurou placeholders, especifique o conteúdo desejado como seus valores:
- Se você planeja reiniciar sua campanha com frequência e não quer que os mesmos usuários entrem na jornada várias vezes, defina Limites de entrada na campanha.
Por exemplo, você criou uma campanha para notificar os usuários sobre uma redução de preço de um produto específico. Você quer reiniciar a jornada algumas vezes enviando várias solicitações com diferentes filtros de público. Neste caso, você pode adicionar Limites de entrada na campanha para que a notificação não seja enviada repetidamente para usuários que correspondem a múltiplos filtros.
- Se você quer que uma jornada seja iniciada sempre que um determinado evento de negócio acontecer, automatize a solicitação usando o webhook. Assim que o evento ocorrer, o webhook deve enviar automaticamente a solicitação para iniciar a jornada.
Você também pode enviar a solicitação manualmente se não precisar de automação.