Skip to content

Einen Braze-zu-Braze-Webhook erstellen

Braze-zu-Braze-Webhooks ermöglichen es Ihnen, die Braze REST API innerhalb von Braze über einen Webhook in einer Campaign oder einem Canvas aufzurufen. Verwenden Sie dies für Orchestrierungsaufgaben wie das Triggern eines API-getriggerten Canvas. Zum Aktualisieren von Nutzerattributen, angepassten Events oder Käufen aus Canvas heraus verwenden Sie stattdessen die Nutzeraktualisierung. Sie ist für Änderungen am Nutzerprofil konzipiert und verarbeitet Updates effizienter.

Um das Beste aus diesem Artikel herauszuholen, sollten Sie mit der Funktionsweise von Webhooks und dem Erstellen eines Webhooks in Braze vertraut sein.

Nutzeraktualisierung für Nutzerdatenänderungen verwenden

Um Nutzerprofile innerhalb eines Canvas zu aktualisieren – einschließlich der Änderung angepasster Attribute, der Aufzeichnung angepasster Events oder der Aufzeichnung von Käufen – verwenden Sie die Nutzeraktualisierung anstelle eines Braze-zu-Braze-Webhooks.

Die Nutzeraktualisierung fasst mehrere Änderungen zusammen und sendet sie in Batches, was schneller ist als Webhooks. Sie ist einfacher einzurichten als ein Webhook und unterstützt komplexe Updates über den erweiterten JSON-Composer. Um beispielsweise zu zählen, wie oft eine Nutzerin oder ein Nutzer eine Nachricht gesehen hat, verwenden Sie die Inkrementieren-und-Dekrementieren-Funktion der Nutzeraktualisierung anstelle eines Braze-zu-Braze-Webhooks.

Wann Sie einen Braze-zu-Braze-Webhook verwenden sollten

Die Nutzeraktualisierung kann nahezu alle Aufgaben eines Braze-zu-Braze-Webhooks für die Aktualisierung von Nutzerprofilen übernehmen. Für komplexe Updates, die über einfache angepasste Attribute hinausgehen, können Sie den erweiterten JSON-Composer verwenden.

Sie können einen Braze-zu-Braze-Webhook verwenden, wenn Sie die REST API von Braze innerhalb von Braze für Szenarien aufrufen müssen, die über direkte Nutzeraktualisierungen aus Canvas-Schritten hinausgehen. Häufige Beispiele sind:

  • Triggern eines API-getriggerten Canvas aus einem anderen Canvas heraus
  • Aufrufen anderer Messaging-Endpunkte für Orchestrierungsmuster, bei denen ein Workflow in Braze eine API aufrufen muss, für die es keine dedizierte Canvas-Komponente gibt

Für Nutzeraktualisierungen innerhalb von Canvas ist die empfohlene Methode die Nutzeraktualisierung.

Voraussetzungen

Um einen Braze-zu-Braze-Webhook zu erstellen, benötigen Sie einen API-Schlüssel mit Berechtigungen für den Endpunkt, den Sie erreichen möchten. Um beispielsweise einen API-getriggerten Canvas zu triggern, benötigen Sie einen API-Schlüssel mit der Berechtigung canvas.trigger.send.

Ihren Braze-zu-Braze-Webhook einrichten

Der allgemeine Workflow zum Erstellen eines Braze-zu-Braze-Webhooks umfasst die folgenden Schritte:

  1. Erstellen Sie einen Webhook als Campaign oder Canvas-Komponente.
  2. Wählen Sie Blank Template.
  3. Geben Sie im Tab Verfassen die Webhook URL und den Request Body für Ihren API-Anwendungsfall an.
  4. Geben Sie im Tab Einstellungen Ihre HTTP Method und Request Headers gemäß den Anforderungen des Endpunkts an.
  5. Konfigurieren Sie alle weiteren Zustellungseinstellungen (z. B. Triggern durch ein angepasstes Event) und erstellen Sie den Rest Ihrer Campaign oder Ihres Canvas.

Einen zweiten Canvas aus einem initialen Canvas triggern

In diesem Anwendungsfall erstellen Sie zwei Canvases und verwenden einen Braze-zu-Braze-Webhook, um den zweiten Canvas aus dem ersten zu triggern. Dies funktioniert wie ein Entry-Trigger, wenn Nutzer:innen einen bestimmten Punkt in einem anderen Canvas erreichen.

  1. Beginnen Sie mit der Erstellung Ihres zweiten Canvas – dem Canvas, der von Ihrem initialen Canvas getriggert werden soll.
  2. Wählen Sie als Entry Schedule des Canvas die Option API-Triggered.
  3. Notieren Sie sich Ihre Canvas ID. Sie benötigen diese in einem späteren Schritt.
  4. Erstellen Sie die weiteren Schritte Ihres zweiten Canvas und speichern Sie den Canvas.
  5. Erstellen Sie abschließend Ihren ersten Canvas. Suchen Sie den Schritt, an dem Sie den zweiten Canvas triggern möchten, und erstellen Sie einen neuen Schritt mit einem Webhook.

Beachten Sie beim Konfigurieren Ihres Webhooks Folgendes:

  • Webhook URL: Ihre REST-Endpunkt-URL gefolgt von /canvas/trigger/send. Für die Instanz US-06 wäre die URL beispielsweise https://rest.iad-06.braze.com/canvas/trigger/send.
  • Request Body: Raw Text

Anfrage-Header und Methode

Braze erfordert einen HTTP-Header für die Autorisierung, der Ihren API-Schlüssel enthält, sowie einen weiteren, der Ihren Content-Typ deklariert.

  • Request Headers:
    • Authorization: Bearer YOUR_API_KEY
    • Content-Type: application/json
  • HTTP Method: POST

Ersetzen Sie YOUR_API_KEY durch einen Braze-API-Schlüssel mit canvas.trigger.send-Berechtigungen. Sie können einen API-Schlüssel im Braze-Dashboard erstellen, indem Sie zu Settings > API Keys navigieren.

Anfrage-Header für den Webhook mit den Feldern „Authorization“ und „Content-Type“ im Braze-Dashboard.

Anfrage-Body

Fügen Sie Ihre /canvas/trigger/send-Anfrage in das Textfeld ein. Weitere Details finden Sie unter Canvas-Nachrichten über API-getriggerte Zustellung senden. Das Folgende ist ein Beispiel für den Anfrage-Body dieses Endpunkts, wobei your_canvas_id die Canvas-ID Ihres zweiten Canvas ist:

1
2
3
4
5
6
7
8

{
  "canvas_id": "your_canvas_id",
  "recipients": [
    {
      "external_user_id": "{{${user_id}}}"
    }
  ]
}

Wenn Nutzer:innen diesen Webhook-Schritt im ersten Canvas erreichen, triggert Braze den zweiten Canvas für diese Nutzer:innen über die API.

Hinweise

  • Nutzeraktualisierungen: Zum Aktualisieren von Nutzerprofilen aus Canvas heraus (Attribute, Events, Käufe) verwenden Sie die Nutzeraktualisierung anstelle von Braze-zu-Braze-Webhooks für bessere Effizienz und Kosteneffektivität.
  • Braze-zu-Braze-Webhooks unterliegen den Rate-Limits der Endpunkte.
  • Aktualisierungen am Nutzerprofil verbrauchen Datenpunkte, die auf Ihren Gesamtverbrauch angerechnet werden, während das Triggern einer weiteren Nachricht über die Messaging-Endpunkte dies nicht tut.
  • Um anonyme Nutzer:innen anzusprechen, verwenden Sie braze_id anstelle von external_id im Anfrage-Body Ihres Webhooks.
  • Sie können Ihren Braze-zu-Braze-Webhook als Webhook-Template zur Wiederverwendung speichern.
  • Sie können das Nachrichten-Aktivitätsprotokoll einsehen, um Webhook-Fehler anzuzeigen und zu beheben.
New Stuff!