⌘I

Leads und Kontakte in HubSpot mit der Formspree CLI erstellen

Updated July 14, 2023 ·
goldplatinumpluginshubspotformspree-cli

Das Hinzufügen der hubspot-Aktion in der Datei formspree.json hat denselben Effekt wie das Hinzufügen des HubSpot-Plugins im Formspree-Dashboard. Im Hilfeartikel zum HubSpot-Plugin erfährst du mehr über leadStatus, lifeCycleStage und weitere Informationen.

Eine Private App erstellen

HubSpot hat den Konto-API-Key abgekündigt. Stattdessen solltest du nun eine Private App erstellen und bestimmte Scopes für das Access-Token auswählen. Weitere Informationen findest du hier.

  • Klicke in deinem HubSpot-Konto auf das Einstellungssymbol in der Hauptnavigationsleiste.
  • Navigiere im linken Seitenleistenmenü zu Integrations>Private Apps.
  • Klicke auf Create private app.
  • Konfiguriere deine App-Details
  • Klicke auf den Tab scopes und aktiviere
    • crm.objects.contacts.read (CRM->Contacts->Read)
    • crm.objects.contacts.write (CRM->Contacts->Read)
    • crm.objects.companies.read (CRM->Companies->Read)
    • crm.objects.companies.write (CRM->Companies->Write)
  • Überprüfe im Dialogfeld die Informationen zum Access-Token deiner App und klicke dann auf Continue creating.

Um mit API-Aufrufen zu beginnen, navigiere zur Detailseite deiner App.

Klicke auf der Karte Access token auf Show token, um dein Access-Token anzuzeigen. Klicke auf Copy, um das Token in deine Zwischenablage zu kopieren, und füge es als accessToken-Attribut in deine Formspree-CLI-Deployment-Datei ein.

Formspree.json-Konfiguration

SchlüsselTypBeschreibung
appStringMuss hubspot sein
typeStringMuss createContact sein
apiKeyStringDein API-Schlüssel (muss eine $-Umgebungsvariablen-Referenz sein, erforderlich) (veraltet)
accessTokenStringDas Access-Token deiner Private App (muss eine $-Umgebungsvariablen-Referenz sein, erforderlich)
leadStatusStringOptionales Feld. Muss einer von NEW, OPEN, IN_PROGRESS, OPEN_DEAL, UNQUALIFIED, ATTEMPTED_TO_CONTACT, CONNECTED oder BAD_TIMING sein. Standard ist NEW.
lifeCycleStageStringOptionales Feld. Muss einer von subscriber, lead, marketingqualifiedlead, salesqualifiedlead, opportunity, customer oder other sein. Standard ist leer.
overwriteContactBooleanOptionales Feld. Wenn true, werden die Kontaktinformationen überschrieben, falls die Kontakt-E-Mail bereits in HubSpot existiert. Standard ist false

Beispiel

{
  "forms": {
    "registrationForm": {
      "name": "Registration Form",
      "actions": [
        {
          "app": "hubspot",
          "type": "createContact",
          "accessToken": "$accessToken",
          "leadStatus": "NEW",
          "lifeCycleStage": "lead",
          "overwriteContact": true
        }
      ]
    }
  }
}

Validierungsregeln

Die Aktion create support ticket fügt implizit die folgenden Validierungsregeln hinzu:

FeldValidierungsregel
emailErforderlich
emailTyp ist email