DocumentaçãoJourney OptimizerGuia do Journey Optimizer

Criar webhooks de feedback para campanhas acionadas por API webhooks

Última atualização: 20 de outubro de 2026

Criado para:

  • Experiente
  • Admin

Nesta página: saiba como criar e configurar webhooks de comentários que fornecem atualizações de status de mensagens em tempo real aos seus sistemas para campanhas transacionais acionadas por API no Adobe Journey Optimizer.

style
shade-box

Os webhooks de feedback permitem que você receba atualizações de status em tempo real para mensagens enviadas por meio de campanhas acionadas por API transacional. Ao configurar um webhook, você pode receber automaticamente os resultados do delivery diretamente para seus sistemas, permitindo monitoramento, registro e processamento automatizado.

Você pode gerenciar configurações de webhook no menu Administração / Canais / Configurações de webhook de comentários.

NOTE
Somente uma configuração de webhook por combinação de Organização + sandbox é permitida.

Criar um webhook de feedback feedback-webhook

Para criar um webhook, siga estas etapas:

  1. Navegue até Administração / Canais / Configurações do webhook de comentários.

  2. Clique em Criar Webhook de Feedback.

  3. Na seção Configuração Básica, forneça os seguintes detalhes:

    • Nome do Webhook - Insira um nome descritivo para identificar o webhook.
    • Canais - Selecione os canais para os quais este webhook deve receber feedback (Email e/ou Celular).
    • URL do Webhook - Forneça o ponto de extremidade HTTPS onde os eventos de comentários devem ser entregues.

  4. Na seção Autenticação, selecione o método de autenticação:

    • Sem Autenticação - Nenhum cabeçalho de autenticação foi adicionado.
    • Autenticação JWT - Forneça os detalhes necessários se o ponto de extremidade exigir autenticação JWT.

  5. Na seção Parâmetros de cabeçalho, configure cabeçalhos personalizados adicionais para serem enviados com cada solicitação de webhook.

  6. Clique em Enviar para salvar a configuração.

NOTE
Você pode editar um webhook a qualquer momento. Para fazer isso, abra-o no inventário e clique no botão Editar.

Estrutura de carga do Webhook

Após a execução de uma mensagem, Journey Optimizer envia a seguinte carga para o ponto de extremidade configurado.

Para obter a definição dos campos de evento de feedback da mensagem, como messageExclusion, consulte a Referência de Esquema do Adobe Journey Optimizer.

O conteúdo inclui os seguintes detalhes de campanha e delivery móvel:

  • messageExecution.campaignType - Tipo de campanha: Scheduled ou ApiTriggered.
  • messageDeliveryFeedback.encoding - Codificação de SMS relatada pelo provedor, como GSM ou UNICODE.
  • messageDeliveryFeedback.numberOfMessageParts - Número de partes (segmentos) de SMS em que a mensagem foi dividida, enviado como uma cadeia de caracteres.
  • messageDeliveryFeedback.deliveryTimestamp - Tempo de evento relatado pelo provedor no formato ISO-8601.
NOTE
Os campos encoding, numberOfMessageParts e deliveryTimestamp estão preenchidos no momento somente para o provedor de SMS Sinch. Campos sem valor são enviados como null.

Carga de amostra de email

{
  "requestId": "8NoByJneShCdCGRnrGS1t1m3CdA73dhR",
  "imsOrg": "myImsOrg",
  "sandbox": {
    "id": "068abf40-575e-11ea-8512-9b1bfdb82603",
    "name": "prod"
  },
  "channel": "email",
  "eventType": "message.feedback",
  "messageExecution": {
    "messageExecutionID": "HUMA-26362805",
    "messageType": "transactional",
    "campaignID": "16f24a15-7e21-477c-848a-d5695ca7f137",
    "campaignVersionID": "2ca10c10-56dd-4505-87cd-fa5da84e7a5d",
    "campaignType": "ApiTriggered"
  },
  "messageDeliveryFeedback": {
    "feedbackStatus": {
      "value": "bounce"
    },
    "offers": null,
    "messageExclusion": null,
    "messageFailure": {
      "category": "sync",
      "type": "Ignored",
      "code": "25",
      "reason": "Admin Failure"
    },
    "retryCount": 0,
    "encoding": null,
    "numberOfMessageParts": null,
    "deliveryTimestamp": null
  },
  "identityMap": {
    "email": [
      {
        "id": "john.doe@luma.com",
        "primary": true
      }
    ]
  }
}

Carga de amostra do SMS

O exemplo a seguir mostra o feedback de delivery de uma mensagem SMS enviada pela Sinch:

{
  "requestId": "4f1c2d9e-...",
  "imsOrg": "XXXX@AdobeOrg",
  "sandbox": {
    "id": "...",
    "name": "prod"
  },
  "channel": "sms",
  "eventType": "message.feedback",
  "channelContext": {
    "profileAddress": null,
    "profileNumber": "+15555550123"
  },
  "messageExecution": {
    "messageExecutionID": "UMA-...",
    "messageType": "marketing",
    "campaignID": "...",
    "campaignVersionID": "...",
    "messageID": "...",
    "messageProfileID": "...",
    "campaignType": "ApiTriggered"
  },
  "messageDeliveryFeedback": {
    "feedbackStatus": {
      "value": "delivered"
    },
    "offers": null,
    "messageExclusion": null,
    "messageFailure": null,
    "retryCount": null,
    "responseCode": null,
    "responseDurationMillis": null,
    "encoding": "GSM",
    "numberOfMessageParts": "2",
    "deliveryTimestamp": "2026-10-06T18:22:41.512Z"
  },
  "identityMap": {
    "Phone": [
      {
        "id": "+15555550123"
      }
    ]
  }
}

O webhook pode capturar os seguintes eventos:

  • Enviado
  • Entregues
  • Rejeição (veja o exemplo acima)
  • Erros

Cada solicitação recebida também inclui um requestId exclusivo que é enviado de volta para o webhook.

Próximas etapas next

Depois que um webhook de feedback for criado, você poderá habilitá-lo ao configurar um público da campanha acionada pela API transacional. Saiba mais nesta seção: Habilitar webhooks

recommendation-more-help
journey-optimizer-help