Wie funktioniert die Definition einer Schnittstelle von und zu HubSpot?

In diesem Artikel beschreiben wir das Prozedere, um eines oder mehrere externe Systeme mit HubSpot zu verbinden.

Damit Marketing, Sales und Service Automation reibungslos funktionieren, müssen alle benötigten Informationen zentral zusammenlaufen. Sollten dabei externe Systeme eine Rolle spielen, benötigen Sie dazu eine Schnittstelle. Die Entwicklung einer Schnittstelle gliedert sich in folgende Bereiche:

  1. Definition der inhaltlichen Anforderungen an die Schnittstelle
  2. Ableitung der Anforderungen als Prozess
  3. Erstellung eines technischen Konzepts
  4. Programmierung und Testing der Schnittstelle
  5. Roll-out & Go-live
  6. Laufender Betrieb & Aktualisierung

Wir können gerne Sie gerne im kompletten Prozess unterstützen. Sollten Sie einige der Punkte mit Ihren Ressourcen abdecken, unterstützen wir Sie gerne nur in einem Teilbereich. Sprich, bei den Punkten 1-5, 3-5, 4-5 oder auch nur 1-3. Wir richten uns hier ganz nach Ihnen.

1. Definition der inhaltlichen Anforderungen an die Schnittstelle

Im ersten Schritt geht es darum, zu definieren, was Sie mit Ihrer Schnittstelle erreichen möchten. Gerne begleiten wir Sie bei der Definition nachfolgender Inhalte.

1.1 Wie sehen die angestrebten Abläufe aus?

Entweder erarbeiten Sie bereits im Vorfeld einen solchen Ablauf oder wir erarbeiten diesen mit Ihnen gemeinsam im Rahmen eines Workshops.

Bei der Definition der Abläufe sind Details noch nicht wichtig. Der Fokus liegt auf den kaufmännischen Aspekten.

Wenn Sie z.B. Daten von Ihrer Webseite nach HubSpot und weiter in ein ERP transportieren wollen, könnte ein solcher Ablauf wie folgt aussehen:

Anforderung Schnittstelle

1.2 Welche Informationen werden zusätzlich benötigt?

Zusätzlich zur einfachen Darstellung des Ablaufs, empfehlen wir Ihnen, User Stories zu erstellen. Diese Stories helfen Ihrer IT und uns, besser zu verstehen, worum es eigentlich geht.

Eine User Story ist nach dem folgenden Prinzip aufgebaut:

Als [ROLLE] möchte ich [FUNKTION], um [NUTZEN].

In unserem Fall würde das bedeuten:

  1. Als Marketing Manager möchte ich, dass Kontaktdaten nach dem Ausfüllen des Formulars "Anfrage" auf unserer Webseite direkt in HubSpot gespeichert werden, um diese für weitere Marketing Maßnahmen nutzen zu können.
  2. Als Operations Manager möchte ich, dass neue Kontakte in unser ERP übernommen werden, um einen Schiefstand beider Systeme ausschließen zu können.

Wir haben zwei User Stories, die gemeinsam den oben skizzierten Ablauf ergeben. Warum sind User Stories wichtig? Einerseits wissen die Schnittstellenentwickler dadurch, welche Abteilung oder Person die Anforderung formuliert hat und können gegebenenfalls Rückfragen stellen. Andererseits gibt eine Story viel mehr Information Preis, als eine reine Beschreibung in Stichworten.

1.3 Wie kann brandREACH Ihnen dabei helfen?

Wir haben viel Erfahrung in der Definition von Abläufen und User Stories. Dadurch wissen wir, worauf es ankommt und wie Sie diesen Schritt effizient umsetzen. Im Folgenden beschreiben wir, wie wir dabei vorgehen:

1.3.1 - Kick-off Termin

Im Kick-off Termin besprechen wir Ihre ersten Schritte. Leider können wir die inhaltliche Definition nur begleiten und nicht komplett für Sie übernehmen. Immerhin sind Sie die fachliche Expert:in auf Ihrem Gebiet. 

Gemeinsam identifizieren wir also die unterschiedlichen Themenbereiche. Als Basis nutzen wir einen Fragenkatalog, der im wesentlichen folgende Aspekte abdeckt:

  • In welchen Systemen speichern Sie aktuell Kontaktdaten?
  • Zwischen welchen Systemen werden Daten aktuell ausgetauscht (manuell oder automatisch)?
  • Wie sehen Ihre Prozesse zur Lead Generierung aus (IST- und SOLL-Zustand)?
  • Wie sehen Ihre Lead Management Prozesse aus (IST- und SOLL-Zustand)?
  • Wie sehen Ihre Lead Re-Engagement Prozesse aus (IST- und SOLL-Zustand)?
  • Wie sehen Ihre Up- & Cross-Selling Prozesse aus (IST- und SOLL-Zustand)?
  • Welche Systeme wollen Sie an HubSpot anschließen?
  • Welche Systeme wollen Sie nicht an HubSpot anschließen?

Abhängig von Ihrem Anwendungsfall können mehr, weniger oder auch ganz andere Fragen von uns gestellt werden.

Das Ziel des Kick-off Termin ist, dass wir den kompletten Umfang abschätzen können und wir definieren, welche Tasks von wem im Anschluss umgesetzt werden.

1.3.2 - Workshops zur Ablaufdefinition

Im Kick-off haben wir alle nötigen Schnittstellen inventarisiert. Nun beginnt die Ausarbeitung.

In gemeinsamen Workshops (von bis zu vier Stunden) zeichnen wir gemeinsam den Ablauf und formulieren die User Stories.

Je nach Komplexität Ihrer Anwendungsfälle sind ein oder mehrere Workshops nötig. Leider lässt sich die exakte Anzahl der Workshops im Vorfeld nicht abschätzen. Wichtig ist, dass die Definition umfassend genug ist, um die späteren Schnittstellen punktgenau umsetzen zu können.

Hier ein paar Beispiel-Fragen, die unter anderem die Komplexität bestimmen: Handelt es sich um so etwas Einfaches, wie das oben beschriebene Beispiel? Oder benötigen Sie auch einen Rückimport? Was passiert bei Änderung oder Löschung von Datensätzen? Gibt es besondere Visualisierungen?

Es gibt viel zu berücksichtigen. Manche Unternehmen benötigen deutlich mehr Funktionalität in ihrer Schnittstelle als andere.

1.4 Was kostet Sie die Unterstützung?

Leider können wir das im Vorfeld nicht genau sagen. Das kommt auf die eben erwähnte Komplexität an. Üblicherweise schätzen wir diesen Punkte pro Schnittstelle mit einem Workshop. Aber tatsächlich tritt die Komplexität erst im Zuge der Ausarbeitung ans Tageslicht.

2. Ableitung der Anforderungen als Prozess

Der grobe Ablauf und die dazugehörigen Stories sind definiert. Nun geht es um die Details.

Ziel dieses Schrittes ist es, die definierten Anforderungen und den Ablauf in eine Form zu bringen, mit der die Entwicklung ein technisches Konzept arbeiten kann. 

2.1 Wie sieht der Prozess der Datenübertragung aus?

An diesem Punkte legen wir mit Ihnen gemeinsam die definierten Abläufe in einen Prozess um. Dabei achten wir darauf, dass wir weder zu granular noch zu sehr an der Oberfläche bleiben, sondern die optimale Vorlage für eine nachgelagerte technische Konzeption erstellen.

API Prozess-1

Wie Sie sehen, ähneln sich Ablauf & Prozess, wobei der Prozess schon etwas detaillierter definiert ist. Bei einem so einfachen Prozess sind die Unterschiede zum Ablauf gering. Anders verhält es sich bei komplexeren Prozessen.

Damit Sie sich besser Zurechtfinden arbeiten wir mit folgendem Farbschema:

  • Türkis: alle Assets des eingesetzten Content Management Systems
  • Orange: alle Assets und Funktionen in HubSpot
  • Schwarz: alle die Schnittstelle betreffenden Informationen

So lässt sich der Prozess beschreiben:

Auf der Landingpage des eingesetzten CMS ist ein Formular aus HubSpot integriert. Deswegen muss das CMS nicht extra angebunden werden. Die Daten werden automatisch nach dem Absenden des Formulars in HubSpot gespeichert.

In HubSpot läuft ein Workflow, der bei einem neu erstellten Kontakt die Eigenschaft "Lead Status" auf "Neu" setzt. Dieser Workflow läuft ebenfalls in HubSpot und muss daher in der Schnittstelle nicht berücksichtigt werden. 

Die Schnittstelle prüft also den Lead Status "Neu" und übergibt anschließend den entsprechenden Kontakt an das ERP System, wo dieser neu angelegt wird.

Warum sind diese Schritte als Vorarbeit zur Schnittstelle nötig? Es hätte auch sein können, dass das Formular aus dem ERP heraus erstellt oder damit verbunden wäre. Damit hätte der Sync in die andere Richtung erstellt werden müssen. Oder aber das eingesetzte CMS muss ohne HubSpot Formulare auskommen und diese müssten evtl. mittels API zuerst nach HubSpot und dann weiter in das ERP. Sie sehen also: Es gibt viele Wege.

2.2 Welche Informationen werden zusätzlich benötigt?

Wir haben den Prozess beschrieben. Zusätzlich werden noch die zu transportierenden Inhalte definiert. Das könnte wie folgt aussehen:

HubSpot Formular HubSpot Datenbank ERP Datenbank
Anrede (Dropdown: Frau/Herr) Anrede (Dropdown: Frau/Herr) Anrede (Dropdown: Frau/Herr)
Vorname (String: Maxi) Vorname (String: Maxi) Vorname (String: Maxi)
Nachname (String: Muster) Nachname (String: Muster) Nachname (String: Muster)
E-Mail-Adresse (String: mm@domain.at) E-Mail-Adresse (String: mm@domain.at) E-Mail-Adresse (String: mm@domain.at)
Consent: (Checkbox: checked/unchecked) Consent (Checkbox: checked/unchecked) Consent (Checkbox: checked/unchecked)
  Quelle der Conversion (Single Choice: Direct Traffic)  
  Date of Conversion (Datepicker 01.01.2000)  
  Date of Consent (Datepicker: 01.01.2000) Date of Consent (Datepicker: 01.01.2000)
  Site Submit (URL: www.domain.at/lp) Site Submit (URL: www.domain.at/lp)
  ...  

Diese Aufstellung liefert uns die benötigten Daten. Einerseits haben wir die explizit erhaltenen Informationen. Also jene Informationen, die unser Lead tatsächlich eingegeben hat. Aber wir haben auch sehr viele implizite Informationen erhalten. Auch diese werden in HubSpot dem Kontakt zugeschrieben.

Wir müssen nun definieren, welche der vorhandenen Informationen an das ERP übertragen werden sollen. Das können beispielsweise nur die expliziten Informationen sein, aber auch Teile der impliziten Informationen, wie Datum der Einwilligung oder die URL, auf der die Conversion stattgefunden hat. 

2.3 Wie kann brandREACH Ihnen dabei helfen?

Wir definieren in fast all unseren Projekten auch die dazugehörigen Schnittstellen oder programmieren diese. Daher sind wir mit der Ausarbeitung und der Aufbereitung von Informationen vertraut. Und wir haben auch Erfahrungen gesammelt, wann welches Datum eine Rolle spielen kann. Unser Know-how stellen wir Ihnen gerne zur Verfügung.

2.3.1 Informationsaufbereitung

Im ersten Schritt nehmen wir die im ersten Punkt ausgearbeiteten Inhalte auf und transportieren diese in einen Prozess und setzen das entsprechende Data Mapping als Vorschlag auf. Wir erstellen also die Prozesse und kümmern uns um das zugehörige Mapping der Daten.

2.3.2 Feinabstimmung

Anschließend setzen wir uns mit Ihnen zusammen und besprechen den, von uns ausgearbeiteten, Entwurf. Dabei werden Änderungen instant eingepflegt und am Ende des Termins haben wir eine fertige Vorlage für die technische Realisierung.

2.4 Was kostet Sie die Unterstützung?

Leider können wir das auch hier noch nicht genau sagen. Es kommt immer noch auf die Komplexität an. Wir rechnen aber auch mit vier Stunden pro Schnittstelle. 

3. Erstellung eines technischen Konzepts

Jetzt ist die Definition schon fast abgeschlossen. Je nachdem, ob wir die komplette Schnittstelle oder Teile davon programmieren, sinkt und steigt der Aufwand für unsere Tätigkeiten.

3.1 Was passiert in dieser Phase?

Je nach Schnittstelle wird ein technisches Flow Chart und die zugehörigen Informationen zur Schnittstelle definiert. Also die Identifikation der jeweiligen API Calls.

Das Flowchart dient als Übersicht um die Datenflüsse und ihre Abhängigkeiten zu visualisieren.
Separat davon ist es nötig die Datenflüsse im Detail zu definieren: um welche Datentypen handelt es sich, sind diese Daten bereinigt bzw. auch im Zielsystem sinnvoll, müssen sie noch in einer Weise verarbeitet oder aggregiert werden, gibt es Logiken, etc..
Auch für das Zielsystem muß die Einordnung und die Darstellung definiert werden - dies ist zumeist vom Anwendungsfall abhängig. Beispielsweise: werden importierte Produkte wieder Produkte oder wird eine Auswahlliste aufgebaut welche alle Produkte enthält.

Um beispielsweise einen kürzlich erstellten Kontakt über die API abzurufen, sieht der jeweilige Call wie folgt aus:

Get recently added contact

Das Ziel in dieser Phase ist es, den technischen Ablauf zu dokumentieren und jene API Calls zu identifizieren, die nötig sind, um die Schnittstelle zu programmieren. Damit das gelingt, ist die Vorarbeit nötig gewesen.

3.2 Wie kann brandREACH Ihnen dabei helfen?

Wir haben schon viele Systeme miteinander verheiratet und sorgen für einen konstanten Austausch an Daten. Daher ist die Programmierung von Schnittstellen eines unserer wichtigsten Assets in Bezug auf HubSpot.

Wir wissen wie HubSpot funktioniert, deswegen fällt es uns leicht die richtigen API Calls zu identifizieren. Und da wir schon mit unterschiedlichen Schnittstellen Kontakt hatten, sind wir es auch gewohnt Neue anzugreifen.

Wir können daher punktgenau ein technisches Umsetzungskonzept liefern, dass entweder uns selbst oder auch Ihren Entwickler:innen als Basis dient.

3.3 Was kostet Sie die Unterstützung?

Die gute Nachricht: Ab hier können wir mit Paketpreisen arbeiten. Haben wir also das inhaltliche Konzept in der Form, wie unter 2.1 und 2.2 beschrieben, vorliegen, schätzen wir das Projekt ab und nennen Ihnen einen Fixpreis.

4. Programmierung und Testing der Schnittstelle

Ist das technische Konzept erstellt, geht es an die Umsetzung. Die große Hürde einer guten Definition ist genommen und damit steht einer soliden Entwicklung nichts im Wege.

3.1 Was passiert in dieser Phase?

Jetzt wird programmiert. Und getestet. Wenn es für Sie spannend ist, finden Sie hier einen Link zur API Dokumentation von HubSpot. Da können Sie auch selbst gerne einen Blick in die unterschiedlichen Calls werfen: https://developers.hubspot.com/docs/api/overview

3.2 Wie kann brandREACH Ihnen dabei helfen?

Natürlich mit unseren Entwicklungsleistungen. Gerne übernehmen wir die Umsetzung Ihrer Schnittstelle für Sie. 

3.3 Was kostet Sie die Unterstützung?

Auch hier gilt: Gibt es ein scharf gestochenes technisches Konzept, können wir Ihnen gerne einen Fixpreis nennen.

5. Roll-out und Go-live

Ist die Schnittstelle programmiert, getestet und von Ihnen abgenommen, dann rollen wir diese auf das Live-System aus. Das ist der für Sie wichtigste, allerdings der technisch am wenigsten herausforderndste Aspekt und auch immer Teil unseres Angebots der Entwicklung einer Schnittstelle.

6. Laufender Betrieb und Aktualisierung

Schnittstellen verändern sich. Alle paar Jahre ändern sich zum Beispiel API Calls u.s.w. Sollten Probleme mit einer unserer Schnittstellen, aus einem solchen Grund auch immer, auftreten, führen wir nach tatsächlichem Aufwand die Aktualisierung der Schnittstelle im Rahmen unserer Service Agreements durch.

Bei manchen Schnittstellen sind auch "Zwischenplattformen" nötig. Gerade dann, wenn vielleicht ganze Files transportiert, bearbeitet und ausgewertet werden sollen und nur die Essenz dieser Daten dann wirklich synchronisiert wird. In einem solchen Fall können auch Gebühren für das Hosting anfallen. Diese Details können Sie allerdings Ihrem Angebot entnehmen.