Unterstützte Produkte
Erfordert eines der folgenden Produkte oder höher.
Letzte Änderung: 28. August 2025
Bitte beachten:
Wenn Sie eine serverlose Funktion als Teil eines Entwicklerprojekts erstellen, besuchen Sie stattdessen die Dokumentation der serverlosen Funktion für Entwicklerprojekte. Die folgende Dokumentation dient zum Erstellen serverloser Funktionen außerhalb der Entwicklerprojektplattform..functions
-Ordner befinden, und die CLI-Befehle, die Sie mit serverlosen Funktionen verwenden können.
Einen umfassenden Überblick über serverlose Funktionen finden Sie in der Übersicht über serverlose Funktionen.
Weitere Informationen zum Erstellen serverloser Funktionen mit Projekten für JavaScript gerenderte Module und Partials finden Sie in der Dokumentation zu Entwicklerprojekten.
Serverless.json
Im.functions
-Ordner speichert die serverless.json
-Datei die Konfiguration der serverlosen Funktion. Dies ist eine erforderliche Datei und sie ordnet Ihre Funktionen ihren Endpunkten zu.
Schlüssel | Type | Description |
---|---|---|
runtime | Zeichenfolge | Die Laufzeitumgebung. Unterstützt die folgenden Node.js-Versionen:
|
version | Zeichenfolge | Schema-Version der serverlose Funktion von HubSpot. (Aktuelle Version 1.0) |
environment | Objekt | Konfigurationsvariablen, die zur Laufzeit als Umgebungsvariablen an die ausführende Funktion übergeben werden. Sie könnten dies verwenden, um eine Logik für die Verwendung einer Testversion einer API anstelle der echten Version auf der Grundlage einer Umgebungsvariablen hinzuzufügen. |
secrets | Array | Ein Array mit den Namen der Geheimnisse, die Ihre serverlose Funktion für die Authentifizierung verwendet. Speichern Sie Geheimniswerte nicht direkt in dieser Datei, sondern verweisen Sie nur auf die Geheimnisnamen. |
endpoints | Objekt | Endpunkte definieren die Pfade, die zugänglich gemacht werden, und ihre Zuordnung zu bestimmten JavaScript-Dateien in Ihrem Funktionsordner. Erfahren Sie unten mehr über Endpunkte. |
Bitte beachten:
Weisen Sie Ihren Geheimnissen und Umgebungsvariablen nicht denselben Namen zu. Andernfalls kommt es zu Konflikten bei der Rückgabe ihrer Werte in der Funktion.Endpunkte
Jeder Endpunkt kann seine eigenen Umgebungsvariablen und Geheimnisse haben. Außerhalb von Endpunkten angegebene Variablen sollten für Konfigurationseinstellungen verwendet werden, die für alle Funktionen und Endpunkte gelten.Schlüssel | Type | Description |
---|---|---|
method | Zeichenfolge oder Array von Zeichenfolgen | HTTP-Methode oder -Methoden, die der Endpunkt unterstützt. Die Standardeinstellung ist GET. |
file | Zeichenfolge | Pfad zur JavaScript-Funktionsdatei mit der Implementierung für den Endpunkt. |
.hs-sites.com
-Subdomains.
Sie können diese Funktionen unter der folgenden URL aufrufen:
https://{domainName}/_hcms/api/{endpoint-name/path}?portalid={hubId}
.
Im Folgenden erfahren Sie mehr über die einzelnen URL-Komponenten:
Parameter | Description |
---|---|
domainName | Ihr Domain-Name. |
/_hcms/api/ | Der für serverlose Funktionen reservierte Pfad. Alle Endpunkte befinden sich innerhalb dieses Pfades. |
endpoint-name/path | Der Endpunktname oder -pfad, den Sie in der serverless.json -Datei angegeben haben. |
hubId | Ihre Hub-ID. Wenn Sie dies in der Anfrage angeben, können Sie Ihre Funktionen in Modul- und Vorlagenvorschauen testen. |
Funktionsdatei
Neben derserverless.json
-Konfigurationsdatei enthält der Ordner .functions
-Ordner auch eine Node.js-JavaScript-Datei, die die Funktion definiert. Sie können die Bibliothek der Anfragen auch verwenden, um HTTP-Anfragen an HubSpot-APIs und andere APIs durchzuführen.
Zum Beispiel:
Kontextobjekt
Das Kontextobjekt enthält Kontextinformationen über die Ausführung der Funktion, die in den folgenden Parametern gespeichert sind.Parameter | Description |
---|---|
accountId | Die HubSpot-Account-ID, die die Funktion enthält. |
body | Wird ausgefüllt, wenn die Anfrage als POST mit dem Inhaltstyp application/json gesendet wird |
contact | Wenn die Anfrage von einem Kontakt mit einem gesetzten Cookie stammt, wird das Kontaktobjekt mit einer Reihe von grundlegenden Kontakteigenschaften mit den folgenden Informationen gefüllt.
|
headers | Enthält die Header, die vom Client gesendet werden, der Ihren Endpunkt erreicht. |
params | Gefüllt mit Abfragezeichenfolgenwerten zusammen mit allen HTML-Formular-POST-Werten. Diese sind als Zuordnung mit Zeichenfolgen als Schlüssel und einem Array von Zeichenfolgen für jeden Wert strukturiert.context.params.yourvalue |
limits | Gibt zurück, wie nah Sie an den Ratenbeschränkungen für serverlose Funktionen.
|
Header
Wenn Sie die Header des Clients, der Ihren Endpunkt erreicht, in Erfahrung bringen müssen, können übercontext.headers
auf diese zugreifen, ähnlich wie Sie über context.body
auf Informationen zugreifen würden.
Im Folgenden finden Sie einige der gängigen Header, die HubSpot bereitstellt. Eine vollständige Liste finden Sie in der HTTP-Header-Dokumentation von MDN.
Header | Description |
---|---|
accept | Teilt mit, welche Inhaltstypen, ausgedrückt als MIME-Typen, der Client versteht. Siehe MDN. |
accept-encoding | Teilt die Inhaltskodierung mit, die der Client versteht. Siehe MDN. |
accept-language | Teilt mit, welche menschliche Sprache und welches Gebietsschema bevorzugt wird. Siehe MDN. |
cache-control | Enthält Richtlinien für die Zwischenspeicherung. Siehe MDN. |
connection | Teilt mit, ob die Netzwerkverbindung offen bleibt. Siehe MDN. |
cookie | Enthält Cookies, die der Client gesendet hat. Siehe MDN. |
host | Übermittelt den Domain-Namen und die TCP-Portnummer eines überwachenden Servers. Siehe MDN. |
true-client-ip | IP-Adresse des Endbenutzers. Siehe Cloudflare true-client-ip. |
upgrade-insecure-requests | Teilt mit, dass die Clients eine verschlüsselte und authentifizierte Antwort wünschen. Siehe MDN. |
user-agent | Vom Hersteller definierte Zeichenfolge zur Identifizierung der Anwendung, des Betriebssystems, des Anwendungsherstellers und der Version. Siehe MDN. |
x-forwarded-for | Identifiziert die ursprüngliche IP-Adresse eines Clients durch einen Proxy oder Load Balancer. Siehe MDN. |
Weiterleitung durch Senden eines Headers
Sie können eine Weiterleitung von Ihrer serverlosen Funktion durchführen, indem Sie eine Antwort mit einem Standort-Header und301
-Status-Code senden.
Cookies von Ihrem Endpunkt aus setzen
Über Ihre serverlose Funktion können Sie dem Client (Webbrowser) mitteilen, dass er ein Cookie setzen soll.Mehrere Werte für einen einzigen Header festlegen
Für Header, die mehrere Werte unterstützen, können SiemultiValueHeaders
verwenden, um die Werte zu übergeben. Zum Beispiel können Sie den Browser anweisen, mehrere Cookies zu setzen.
Geheimnisse
Wenn Sie eine Anfrage der serverlosen Funktionen authentifizieren müssen, verwenden Sie Geheimnisse, um Werte wie API-Schlüssel oder private App-Zugriffstoken zu speichern. Mit dem CLI können Sie Ihrem HubSpot-Account Geheimnisse hinzufügen, um diese Werte zu speichern, auf die Sie später über Umgebungsvariablen (process.env.secretName
) zugreifen können. Geheimnisse werden über die HubSpot-Befehlszeile mit den folgenden Befehlen verwaltet:
Sobald Geheimnisse über das CLI hinzugefügt wurden, können sie Funktionen zur Verfügung gestellt werden, indem ein secrets
-Array mit dem Namen des Geheimnisses hinzugefügt wird. Auf diese Weise können Sie Ihren Funktionscode in der Versionskontrolle speichern und Geheimnisse verwenden, ohne sie preiszugeben. Sie sollten jedoch niemals den Wert Ihres Geheimnisses durch Konsolenprotokollierung oder als Antwort zurückgeben, da dies das Geheimnis in Protokollen oder auf Frontend-Seiten preisgibt, die Ihre serverlose Funktion aufrufen.
Bitte beachten:
Aufgrund der Zwischenspeicherung kann es etwa eine Minute dauern, bis aktualisierte geheime Werte angezeigt werden. Wenn Sie gerade ein Geheimnis aktualisiert haben, aber immer noch den alten Wert sehen, überprüfen Sie es nach etwa einer Minute erneut.Verwendung von serverlosen Funktionen mit dem form-Element
Bei der Übermittlung von serverlosen Funktionen verwenden Sie JavaScript, um die Formulareinsendung zu verarbeiten, und verwenden Sie den"contentType" : "application/json"
-Header in Ihrer Anfrage. Verwenden Sie nicht das action
-Attribut <form>
-Elemente.
CORS
Cross Origin Resource Sharing (CORS) ist eine Sicherheitsfunktion des Browsers. Standardmäßig schränken Browser durch JavaScript initiierte herkunftsübergreifende Anfragen ein. Dadurch wird verhindert, dass bösartiger Code, der auf einer anderen Domain läuft, Ihre Website beeinträchtigt. Dies wird als Same-Origin-Policy bezeichnet. Da das Senden und Abrufen von Daten von anderen Servern manchmal notwendig ist, kann der externe Server HTTP-Header bereitstellen, die mitteilen, welche Herkunft die Informationen von einem Browser lesen darf. Sie sollten keine CORS-Probleme haben, wenn Sie Ihre serverlose Funktion innerhalb Ihrer von HubSpot gehosteten Seiten aufrufen. Wenn dies doch der Fall ist, vergewissern Sie sich, dass Sie das richtige Protokoll verwenden.Erhalten Sie diesen CORS-Fehler?“Access to fetch at [Ihre Funktions-URL] from origin [Seite, die die Anfrage stellt] has been blocked by CORS policy: Response to preflight request doesn’t pass access control check: No ‘Access-Control-Allow-Origin’ header is present on the requested resource. If an opaque response serves your needs, set the request’s mode to ‘no-cors’ to fetch the resource with CORS disabled.”Geht Ihre Anfrage an einen anderen Ursprung als die aufrufende Seite?
- Wenn der Domain-Name anders ist, ja.
- Bei Verwendung eines anderen Protokolls (http, https), ja.
Access-Control-Allow-Origin-Header
von HubSpot derzeit nicht ändern.Siehe MDN für weitere detaillierte CORS-Fehlerbehebung.GET-Anfragen
GET-Anfragen können je nach Client auch CORS-Anfragen stellen. Bei GET-Anfragen wird nichts geschrieben, sondern nur Daten zurückgegeben.Vorinstallierte Pakete
Serverlose HubSpot-Funktionen werden derzeit mit den folgenden Paketen vorinstalliert:- @hubspot/api-client: ^1.0.0-beta
- axios: ^0.19.2
- request: ^2.88.0
- requests: ^0.2.2
- Klonen oder kopieren Sie Ihre Funktionsdatei.
- Ändern Sie den Endpunkt Ihrer Funktion in der
serverless.json
-Datei, um auf Ihre neue Funktionsdatei zu verweisen. Sie können die alte Version bedenkenlos löschen.
Beschränkungen
Serverlose Funktionen sollen schnell sein und einen engen Fokus haben. Um schnelle Aufrufe und Antworten zu ermöglichen, unterliegen die serverlosen Funktionen von HubSpot folgenden Beschränkungen:- 50 Geheimnisse pro Account.
- 128 MB Speicher.
- Nicht mehr als 100 Endpunkte pro HubSpot-Account
- Sie müssen
contentType
application/json
beim Aufrufen einer Funktion verwenden. - Protokolle der serverlose Funktionen werden 90 Tage lang gespeichert.
- 6 MB in einer AWS Lambda-Aufruf-Payload.
- Jede Funktion hat eine maximale Ausführungszeit von 10 Sekunden.
- Jeder Account ist auf insgesamt 600 Ausführungssekunden pro Minute beschränkt.
- 60 Funktionsausführungen, die jeweils 10 Sekunden in Anspruch nehmen.
- 6.000 Funktionsausführungen, die 100 Millisekunden dauern.
429
-Antwort zurück. Die Ausführungszeit jeder Funktion wird in den Protokollen der serverlosen Funktionen berücksichtigt.
Um diese Beschränkungen zu umgehen, werden dem Funktionskontext während der Ausführung automatisch Daten für Obergrenzen zur Verfügung gestellt. Sie können dies nutzen, um Ihre Anwendung so zu beeinflussen, dass sie innerhalb dieser Obergrenzen bleibt. Wenn Ihre Anwendung beispielsweise die Abfrage Ihres Endpunkts erfordert, können Sie mit Ihren Daten eine Variable zurückgeben, um die Häufigkeit der Abfrage zu beeinflussen. Auf diese Weise können Sie bei hohem Traffic die Abrufrate verlangsamen, um ein Überschreiten der Obergrenzen zu vermeiden, und sie dann bei geringem Traffic wieder erhöhen.