Nesta página: saiba como usar ações personalizadas para conectar uma jornada a um sistema de terceiros por meio de uma chamada de API REST com uma carga JSON, ao mesmo tempo em que aplica políticas de consentimento e governança de dados.
Use ações personalizadas para habilitar a conexão com um sistema de terceiros para enviar mensagens ou chamadas de API. Uma ação pode ser configurada com qualquer serviço de qualquer provedor que possa ser chamado por meio de uma REST API com conteúdo formatado em JSON.
Saiba mais sobre ações personalizadas em esta seção.
Saiba como criar e configurar uma ação personalizada em esta página.
Saiba como usar respostas de chamada de API de ações personalizadas para personalização em esta página.
Consentimento e governança de dados privacy
No Journey Optimizer, você pode aplicar políticas de consentimento e governança de dados às ações personalizadas para impedir que campos específicos sejam exportados para sistemas de terceiros ou excluir clientes que não consentiram em receber comunicações por email, push ou SMS. Para obter mais informações, consulte as seguintes páginas:
Configurar o URL
O painel de configuração da atividade Ação personalizada mostra os parâmetros de configuração de URL e os parâmetros de autenticação configurados para a ação personalizada. Não é possível definir a parte estática do URL na jornada, mas na configuração global da ação personalizada. Saiba mais.
Caminho dinâmico
Se a URL incluir um caminho dinâmico, especifique o caminho no campo Caminho.
Para concatenar campos e cadeias de caracteres de texto sem formatação, use as funções String ou o sinal de adição (+) no editor de expressão avançado. Coloque cadeias de texto sem formatação entre aspas simples (') ou entre aspas duplas ("). Saiba mais.
Esta tabela mostra um exemplo de configuração:
https://xxx.yyy.com:8080/somethingstatic/The _id + '/messages'O URL concatenado tem este formato:
https://xxx.yyy.com:8080/somethingstatic/<ID>/messages
Cabeçalhos e parâmetros de consulta headers
A seção Configuração de URL mostra os campos de cabeçalho dinâmico e parâmetro de consulta, mas não os campos constantes. Os campos de parâmetro de cabeçalho e consulta dinâmicos são definidos como variáveis na tela de configuração de ação. Saiba mais
Para especificar o valor dos campos de cabeçalho dinâmico e parâmetro de consulta, clique dentro do campo ou no ícone de lápis e selecione o campo desejado.
Parâmetros de ação
Na seção Parâmetros de ação, você verá os parâmetros de mensagem definidos como “Variável”. Para esses parâmetros, você pode definir onde obter essas informações (por exemplo: eventos, fontes de dados), transmitir valores manualmente ou usar o editor de expressão avançado para casos de uso avançados. Casos de uso avançados podem ser manipulação de dados e outro uso de função. Consulte esta página.
This section contains structured knowledge intended to support interpretation, retrieval, and question answering related to this topic.
For complete understanding, this information should be combined with the documentation on this page. Neither source is intended to stand alone; the page describes the feature, while this section provides additional context that helps disambiguate terminology, intent, applicability, and constraints.
- TL;DR: This page explains how to add and configure a custom action activity in a journey to call a third-party REST API with a JSON payload, including URL configuration, header/query parameter mapping, action parameter mapping, and applying data governance and consent policies.
Intents:
- Add a custom action activity to a journey to send data to a third-party system via REST API
- Configure a dynamic URL path by concatenating fields and static text in the expression editor
- Map dynamic header and query parameter values from journey events or datasources
- Map action parameters (defined as Variable) to event fields, datasource fields, or static values
- Apply data governance and consent policies to control what data is exported via custom actions
Glossary:
- Custom action: A journey action activity that calls an external REST API endpoint with a JSON-formatted payload to integrate third-party systems (product-specific)
- Dynamic path: The variable portion of the custom action URL that is defined per-execution using fields from the journey context (product-specific)
- Action parameters: Message payload fields defined as “Variable” in the custom action configuration, mapped to journey data at the journey level (product-specific)
Guardrails:
- The static part of the URL cannot be modified in the journey; it must be set in the global custom action configuration.
- Dynamic header and query parameter fields are defined as variable in the action configuration screen, not in the journey.
- Data governance and consent policies can be applied to prevent specific fields from being exported or to exclude non-consented customers.
Terminology:
- Canonical name: Custom action — Acronym: none — variants: custom actions, third-party action
- Synonyms: “action parameters” = “message parameters defined as Variable”
- Do not confuse: “static URL part” (set in global action config, not editable in journey) ≠ “dynamic path” (set in the journey per-execution)
FAQ:
- Q: Can I change the base URL of a custom action inside the journey? — No, only the dynamic path portion can be set in the journey; the static part of the URL is configured in the global custom action configuration.
- Q: How do I build a dynamic URL path that includes a profile ID? — Use the Path field with the advanced expression editor to concatenate the ID field with static strings, for example:
_id + '/messages'. - Q: How do I apply consent rules to a custom action? — Configure consent policies on the custom action to exclude customers who have not consented to receive the relevant communication; refer to the Consent page for details.
- Q: Where do I map the values for dynamic headers? — In the URL Configuration section of the activity pane, click inside the dynamic header field or use the pencil icon to select the desired field from events or datasources.
- Q: What types of values can I assign to action parameters? — You can map parameters to event fields, datasource fields, pass values manually, or use the advanced expression editor for data manipulation.