Enviar mensagens do Canvas usando entrega acionada por API

Use este endpoint para enviar mensagens do Canvas com entrega acionada por API.

A entrega acionada por API permite que você armazene o conteúdo da mensagem no dashboard da Braze enquanto determina quando uma mensagem é enviada e para quem usando sua API.

Antes de enviar mensagens com esse endpoint, você deve ter um ID do Canvas (que é criado quando você constrói um Canvas).

Pré-requisitos

Para usar esse endpoint, você precisará gerar uma chave de API com a permissão canvas.trigger.send.

Limite de taxa

Ao usar filtros de público conectado em sua solicitação, aplicamos um limite de taxa de 250 solicitações por minuto a esse endpoint. Caso contrário, se estiver especificando um external_id, esse endpoint tem um limite de taxa padrão de 250.000 solicitações por hora compartilhado entre os endpoints documentados em Limites de taxa da API.

Os endpoints da Braze aceitam solicitações de API em lote. Uma única solicitação para os endpoints de envio de mensagens pode alcançar qualquer um dos seguintes itens:

• Até 50 external_ids específicos, cada um com parâmetros de mensagem individuais
• Um segmento de público de qualquer tamanho, definido na solicitação como um objeto de público conectado

Os endpoints da Braze aceitam solicitações de API em lote. Uma única solicitação para os endpoints de envio de mensagens pode alcançar qualquer um dos seguintes itens:

• Até 50 external_ids específicos, cada um com parâmetros de mensagem individuais
• Um segmento de público de qualquer tamanho, definido na solicitação como um objeto de público conectado

Corpo da solicitação

1
2
Content-Type: application/json
Authorization: Bearer YOUR-REST-API-KEY

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
{
  "canvas_id": (required, string) see Canvas identifier,
  "context": (optional, object) Canvas context properties that apply to all users in this request,
  "broadcast": (optional, boolean) see Broadcast -- defaults to false on 8/31/17, must be set to true if `recipients` is omitted,
  "audience": (optional, connected audience object) see connected audience,
  // Including 'audience' will only send to users in the audience
  "recipients": (optional, array; if not provided and broadcast is not set to 'false', message sends to the entire segment targeted by the Canvas)
    [{
      // Either "external_user_id" or "user_alias" or "email" is required. Requests must specify only one.
      "user_alias": (optional, user alias object) user alias of user to receive message,
      "external_user_id": (optional, string) external identifier of user to receive message,
      "email": (optional, string) email address of user to receive message,
      "prioritization": (optional, array) prioritization array; required when using email,
      "context": (optional, object) Canvas context properties for this user; key-value pairs override any keys that conflict with the parent `context`,
      "send_to_existing_only": (optional, boolean) defaults to true, can't be used with user aliases; if set to `false`, an `attributes` object must also be included,
      "attributes": (optional, object) fields in the attributes object create or update an attribute of that name with the given value on the specified user profile before the message is sent and existing values are overwritten
    }],
    ...
}

Parâmetros de solicitação

Exemplo de solicitação

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
curl --location --request POST 'https://rest.iad-01.braze.com/canvas/trigger/send' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YOUR-REST-API-KEY' \
--data-raw '{
  "canvas_id": "canvas_identifier",
  "context": {"product_name" : "shoes", "product_price" : 79.99},
  "broadcast": false,
  "audience": {
    "AND": [
      {
        "custom_attribute": {
          "custom_attribute_name": "eye_color",
          "comparison": "equals",
          "value": "blue"
        }
      },
      {
        "custom_attribute": {
          "custom_attribute_name": "favorite_foods",
          "comparison": "includes_value",
          "value": "pizza"
        }
      },
      {
        "OR": [
          {
            "custom_attribute": {
              "custom_attribute_name": "last_purchase_time",
              "comparison": "less_than_x_days_ago",
              "value": 2
            }
          },
          {
            "push_subscription_status": {
              "comparison": "is",
              "value": "opted_in"
            }
          }
        ]
      },
      {
        "email_subscription_status": {
          "comparison": "is_not",
          "value": "subscribed"
        }
      },
      {
        "last_used_app": {
          "comparison": "after",
          "value": "2019-07-22T13:17:55+0000"
        }
      }
    ]
  },
  "recipients": [
    {
      "user_alias": {
        "alias_name" : "example_name",
        "alias_label" : "example_label"
      },
      "external_user_id": "user_identifier",
      "send_to_existing_only": true,
      "attributes": {
          "first_name" : "Alex"
      }
    }
  ]
}'

Detalhes da resposta

As respostas do endpoint de envio de mensagens incluem o dispatch_id da mensagem para referência ao despacho da mensagem. O dispatch_id é o ID do despacho de mensagens (ID exclusivo para cada “transmissão” enviada da plataforma Braze). Para saber mais, consulte Comportamento do Dispatch ID.

Exemplo de resposta bem-sucedida

O código de status 201 pode retornar o seguinte corpo de resposta. Se o Canvas estiver arquivado, parado ou pausado, ele não é enviado por meio deste endpoint.

1
2
3
4
5
{
  "notice": "The Canvas is paused. Resume the Canvas to ensure trigger requests will take effect.",
  "dispatch_id": "example_dispatch_id",
  "message": "success"
}

Se o seu Canvas estiver arquivado, você verá esta mensagem notice: “The Canvas is archived. Unarchive the Canvas to ensure trigger requests will take effect.” Se o seu Canvas não estiver ativo, você verá esta mensagem notice: “The Canvas is paused. Resume the Canvas to ensure trigger requests will take effect.”

Se sua solicitação encontrar um erro fatal, consulte Erros e respostas para obter o código e a descrição do erro.

Considerações

Considere o seguinte ao fazer chamadas de API para enviar mensagens do Canvas usando entrega acionada por API:

• Envio para usuários existentes: Quando send_to_existing_only está definido como true (o padrão), a mensagem é enviada apenas para usuários existentes na Braze.
• Criação de novos usuários: Quando send_to_existing_only está definido como false, você deve incluir um objeto attributes. Se um usuário com o ID especificado não existir, a Braze cria um usuário com esse ID e atributos antes de enviar a mensagem.
• Perfis novos precisam de attributes com send_to_existing_only: false. A Braze executa a criação ou atualização pré-envio a partir do objeto attributes no mesmo destinatário. Se você definir send_to_existing_only como false, mas omitir attributes (ou enviar um objeto vazio), a Braze não hidrata os dados do perfil da mesma forma, então você não obtém o comportamento combinado de “criar ou atualizar usuário e depois enviar” para o qual esse padrão foi projetado.
• Endereçamento de e-mail e SMS. Para a maioria dos envios de e-mail ou SMS acionados por API para alguém que ainda não está na Braze, inclua os campos de entrega necessários dentro de attributes (por exemplo, email ou os atributos de telefone que seu espaço de trabalho usa para SMS). Você também pode definir a associação ao grupo de inscrições ou o status de inscrição quando o estado de opt-in precisa mudar na mesma chamada.
• Elegibilidade do Canvas. Depois que o perfil existe ou é atualizado, esse usuário ainda deve corresponder ao público-alvo do Canvas no dashboard e às regras de envio do canal (por exemplo, ter opt-in para e-mail) para que a Braze envie a mensagem.
• Limitação de alias de usuário: A flag send_to_existing_only não pode ser usada com aliases de usuário. Para enviar para um usuário que possui apenas um alias, o usuário já deve existir na Braze.
• Direcionamento de segmento: O parâmetro segment_id não é suportado para este endpoint. Para direcionar um segmento, configure o segmento nas configurações de público-alvo do Canvas no dashboard da Braze e use broadcast: true, ou use o parâmetro audience com filtros de Público conectado.
• Direcionamento combinado: Quando você inclui tanto o parâmetro recipients quanto configura um segmento alvo no dashboard, a mensagem é enviada apenas para os perfis de usuário que estão especificados na chamada da API e que também correspondem aos filtros do segmento.
• Chamadas de servidor para servidor: Se você estiver fazendo chamadas de servidor para servidor, pode ser necessário adicionar a URL da API apropriada à lista de permissões se você estiver atrás de um firewall.

Objeto de atributos para Canvas

Use o objeto de envio de mensagens attributes para adicionar, criar ou atualizar atributos e valores para um usuário antes de enviar um Canvas acionado por API usando o endpoint canvas/trigger/send. Esta chamada de API processa o objeto de atributos do usuário antes de processar e enviar o Canvas. Isso ajuda a minimizar o risco de problemas causados por condições de corrida. No entanto, por padrão, os grupos de inscrições não podem ser atualizados dessa forma.

Nota

Procurando a versão de Campaign deste endpoint? Confira Envio de mensagens de Campaign usando entrega acionada por API.