Enviar mensagens do Canva por meio de entrega disparada pela API

Use esse endpoint para enviar mensagens do canva por meio de entrega disparada pela API.

A entrega disparada por API permite que você armazene o conteúdo da mensagem no dashboard do Braze e, ao mesmo tempo, determine quando a mensagem será enviada e para quem por meio de 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

When specifying a segment or Connected Audience in your request, we apply a rate limit of 250 requests per minute to this endpoint. Otherwise, if specifying an external_id, this endpoint has a default rate limit of 250,000 requests per hour shared between /messages/send, /campaigns/trigger/send, and /canvas/trigger/send, as documented in API rate limits.

Braze endpoints support batching API requests. A single request to the messaging endpoints can reach any of the following:

• Up to 50 specific external_ids, each with individual message parameters
• A segment of any size created in the Braze dashboard, specified by its segment_id
• An audience segment of any size, defined in the request as a connected audience object

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,
  "canvas_entry_properties": (optional, object) personalization key-value pairs that will 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 will send 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,
      "canvas_entry_properties": (optional, object) personalization key-value pairs that will apply to this user (these key-value pairs will override any keys that conflict with the parent `canvas_entry_properties`)
      "send_to_existing_only": (optional, boolean) defaults to true, can't be used with user aliases
      "attributes": (optional, object) fields in the attributes object will 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 will be overwritten
    }],
    ...
}

Parâmetros de solicitação

Os clientes que usam a API para chamadas de servidor para servidor talvez precisem listar o URL apropriado da API se estiverem protegidos por um firewall.

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",
  "canvas_entry_properties": {"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 incluirão o endereço dispatch_id da mensagem para referência ao envio da mensagem. O endereço dispatch_id é o ID do envio 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 canva for arquivado, interrompido ou pausado, ele não será enviado por meio desse 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 canva estiver arquivado, você verá a mensagem notice: “O Canva está arquivado. Desarquive o Canva para garantir que as solicitações de disparo tenham efeito.” Se o canva não estiver ativo, você verá a mensagem notice: “O Canva está em pausa. Retome o Canva para garantir que as solicitações de disparo tenham efeito.”

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

Objeto de atribuições para o Canva

Use o objeto de envio de mensagens attributes para adicionar, criar ou atualizar atribuições e valores para um usuário antes de enviar a ele um Canva disparado pela API usando o ponto de extremidade canvas/trigger/send. Essa chamada da API processa o objeto de atribuições do usuário antes de processar e enviar a tela. Isso ajuda a minimizar o risco de problemas causados por condições de corrida.