Envoyer des messages Canvas via une livraison déclenchée par API

Utilisez cet endpoint pour envoyer des messages Canvas via la livraison déclenchée par API.

La livraison déclenchée par API vous permet de stocker le contenu d’un message dans le tableau de bord de Braze, tout en indiquant quand et à qui un message est envoyé via votre API.

Avant de pouvoir envoyer des messages avec cet endpoint, vous devez disposer d’un ID Canvas (qui est créé lorsque vous créez un Canvas).

Conditions préalables

Pour utiliser cet endpoint, vous devrez générer une clé API avec l’autorisation canvas.trigger.send.

Limite de débit

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

Corps de la demande

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
    }],
    ...
}

Paramètres de demande

Les clients qui utilisent l’API pour des appels de serveur à serveur peuvent avoir besoin d’autoriser l’URL API appropriée s’ils sont derrière un pare-feu.

Exemple de demande

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"
      }
    }
  ]
}'

Informations relatives à la réponse

Les réponses des endpoints d’envoi de messages incluront le dispatch_id du message pour y faire référence lors de l’envoi. Le dispatch_id est l’ID de distribution du message (ID unique pour chaque « transmission » envoyée depuis la plateforme Braze). Consultez Comportement du Dispatch ID pour plus d’informations.

Exemple de réponse réussie

Le code de statut 201 pourrait renvoyer le corps de réponse suivant. Si le Canvas est archivé, arrêté ou en pause, le Canvas ne sera pas envoyé via ce point de terminaison.

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"
}

Si votre Canvas est archivé, vous verrez ce message notice: “The Canvas” est archivé. Désarchivez le Canvas pour vous assurer que les demandes de déclencheurs prendront effet.” Si votre Canvas n’est pas actif, vous verrez ce message notice: “La toile est en pause. Reprenez le Canvas pour vous assurer que les demandes de déclencheurs prendront effet.”

Si votre demande rencontre une erreur fatale, reportez-vous à la section Erreurs et réponses pour connaître le code d’erreur et sa description.

Objet d’attributs pour Canvas

Utilisez l’objet de message attributes pour ajouter, créer ou mettre à jour les attributs et les valeurs d’un utilisateur avant de lui envoyer un canvas déclenché par l’API à l’aide de l’endpoint canvas/trigger/send. Cet appel API traite l’objet des attributs de l’utilisateur avant de traiter et d’envoyer le canvas. Cela permet de minimiser le risque de problèmes causés par des conditions de concurrence.