Skip to content

Lob

Lob.com ist ein Online-Dienst, der es Ihnen ermöglicht, Direkt-Mailings an Ihre Nutzer:innen zu senden.

Diese Integration wird von Lob gepflegt.

Über die Integration

Mit dieser Integration können Sie:

  • Briefe, Postkarten und Schecks über die Post versenden – mithilfe von Braze-Webhooks und der Lob API.
  • Lob-Events als angepasste Attribute und Events über Braze-Datentransformation und Lob-Webhooks mit Braze teilen.

Voraussetzungen

Versenden von Post mit Braze-Webhooks

1. Schritt: Wählen Sie einen Lob-Endpunkt

Je nachdem, was Sie in Lob tun möchten, müssen Sie den entsprechenden Endpunkt in der HTTP-Anfrage Ihres Webhooks verwenden. Ausführliche Informationen zu den einzelnen Endpunkten finden Sie in der API-Referenzdokumentation von Lob.

2. Schritt: Erstellen Sie Ihr Braze-Webhook-Template

Um ein Lob-Webhook-Template zu erstellen, das Sie in zukünftigen Campaigns oder Canvases verwenden können, navigieren Sie im Braze-Dashboard zu Content > Webhook. Wählen Sie dann Create webhook template.

Wenn Sie eine einmalige Lob-Webhook-Campaign erstellen oder ein bestehendes Template verwenden möchten, wählen Sie bei der Erstellung einer neuen Campaign Webhook in Braze aus.

Füllen Sie in Ihrem neuen Webhook-Template die folgenden Felder aus:

  • Webhook-URL: <LOB_API_ENDPOINT>
  • Anfrage-Body: Rohtext

Anfrage-Header und Methode

Lob benötigt einen HTTP-Header für die Autorisierung und eine HTTP-Methode. Die folgenden Angaben sind bereits als Schlüssel-Wert-Paar im Template enthalten, aber auf dem Tab Einstellungen müssen Sie <LOB_API_KEY> durch Ihren Lob API-Schlüssel ersetzen. Dieser Schlüssel muss ein „:“ direkt nach dem Schlüssel enthalten und in Base 64 kodiert sein.

  • HTTP-Methode: POST
  • Anfrage-Header:
    • Authorization: Basic <LOB_API_KEY>:
    • Content-Type: application/json

Anfrage-Body-Code und Webhook-URL im Tab „Verfassen“ des Braze-Webhook-Builders.

Anfrage-Body

Im Folgenden sehen Sie einen Beispiel-Anfrage-Body für den Lob-Postcards-Endpunkt. Dieser Anfrage-Body wird zwar im Basis-Lob-Template in Braze bereitgestellt, aber wenn Sie andere Endpunkte verwenden möchten, müssen Sie Ihre Liquid-Felder entsprechend anpassen.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
{
  "description": "Demo Postcard",
  "to": {
    "name": "{{${first_name}}} {{${last_name}}}",
    "address_line1": "{{custom_attribute.${address_line1}}}",
    "address_city": "{{custom_attribute.${address_city}}}",
    "address_zip": "{{custom_attribute.${address_zip}}}",
    "address_country": "{{custom_attribute.${address_country}}}"
  },
  "front": "https://lob.com/postcardfront.pdf",
  "back": "https://lob.com/postcardback.pdf",
  "use_type": "marketing",
  "size": "6x11"
}

3. Schritt: Vorschau Ihrer Anfrage

An diesem Punkt sollte Ihre Campaign bereit zum Testen und Versenden sein. Überprüfen Sie das Lob-Dashboard und die Fehlermeldungsprotokolle in der Braze-Entwicklungskonsole, wenn Fehler auftreten. Der folgende Fehler wurde beispielsweise durch einen falsch formatierten Authentifizierungs-Header verursacht.

Ein Fehlermeldungsprotokoll, das die Zeit, den App-Namen, den Kanal und die Fehlermeldung anzeigt. Die Fehlermeldung enthält den Nachrichtenhinweis und den Statuscode.

Events über Lob-Webhooks teilen

Mit Braze-Datentransformation können Sie Webhooks zur Automatisierung des Datenflusses von externen Plattformen in Braze erstellen und verwalten. Jede Transformation erhält einen eindeutigen Endpunkt, den andere Plattformen als Ziel für ihren Webhook verwenden können.

1. Schritt: Erstellen Sie eine Transformation in Braze

  1. Navigieren Sie im Braze-Dashboard zu Data Settings > Data Transformations, und wählen Sie dann Create Transformation.
  2. Geben Sie einen kurzen, beschreibenden Namen für Ihre Transformation ein.
  3. Wählen Sie unter Bearbeitungserfahrung die Option Template verwenden aus, suchen Sie dann nach Lob und aktivieren Sie das Kontrollkästchen.
  4. Wenn Sie fertig sind, wählen Sie Transformation erstellen. Sie werden zum Transformations-Editor weitergeleitet, den Sie im nächsten Schritt verwenden.

2. Schritt: Füllen Sie das Lob-Template aus

Mit diesem Template können Sie eines Ihrer Lob-Events in ein angepasstes Event oder Attribut transformieren, das in Braze verwendet werden kann. Folgen Sie den Inline-Kommentaren, um das Template fertigzustellen.

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
// First, this code defines a variable, "brazecall", to build up a /users/track request
// Everything from the incoming webhook is accessible via the special variable "payload". As such, you can template in desired values in your /users/track request with JavaScript dot notation, such as payload.x.y.z

// In this example, this function removes the periods and underscores of the event_type.id sent in the Lob payload so that an event id that is formatted like: `letter.processed_for_delivery` will log an event to Braze with the name `letter processed for delivery`.

function formatString(input) {
    return input.replace(/[._]/g, ' ');
}

let braze_event = formatString(payload.event_type.id);

// In this example, a metadata value passed in the Lob Webhook called 'external_ID' is being used to match the Event to the corresponding Braze user.

let brazecall = {
  "attributes": [
    {
      "external_id": payload.body.metadata.external_id,
      "_update_existing_only": true,
      "Most Recent Mailer": payload.body.description
    }
  ],
  "events": [
    {
      "external_id": payload.body.metadata.external_id,
      "_update_existing_only": true,
      "name": braze_event,
      "time": new Date().toISOString(),
// Customize the properties to the Lob event you are syncing. Our example below pulls in the Tracking Events array of objects associated with certain Lob events.
      "properties": {
        "tracking_events": payload.body.tracking_events
      }
    }
  ]
};
// After the /users/track request is assigned to brazecall, you will want to explicitly return brazecall to create an output
return brazecall;

3. Schritt: Erstellen Sie einen Webhook in Lob

  1. Wenn Sie mit der Erstellung Ihres Templates fertig sind, wählen Sie Aktivieren und kopieren Sie die Webhook-URL in Ihre Zwischenablage.
  2. Erstellen Sie in Lob einen neuen Webhook und verwenden Sie dann Ihre Webhook-URL von Braze, um den Webhook zu empfangen.
New Stuff!