Zum Hauptinhalt springen
POST
/
events
/
v3
/
event-definitions
Definition für benutzerdefiniertes Event erstellen
curl --request POST \
  --url https://api.hubapi.com/events/v3/event-definitions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "description": "<string>",
  "label": "<string>",
  "name": "<string>",
  "primaryObject": "<string>",
  "propertyDefinitions": [
    {
      "description": "<string>",
      "label": "<string>",
      "name": "<string>",
      "options": [
        {
          "description": "<string>",
          "displayOrder": 123,
          "hidden": true,
          "label": "<string>",
          "value": "<string>"
        }
      ],
      "type": "<string>"
    }
  ]
}'
{
  "archived": true,
  "associations": [
    {
      "allowsCustomLabels": true,
      "cardinality": "ONE_TO_MANY",
      "category": "HUBSPOT_DEFINED",
      "fromObjectType": "ABANDONED_CART",
      "fromObjectTypeId": "<string>",
      "hasAllAssociatedObjects": true,
      "hasCascadingDeletes": true,
      "hasUserEnforcedMaxFromObjectIds": true,
      "hasUserEnforcedMaxToObjectIds": true,
      "hidden": true,
      "id": 123,
      "inverseAllowsCustomLabels": true,
      "inverseCardinality": "ONE_TO_MANY",
      "inverseHasAllAssociatedObjects": true,
      "inverseId": 123,
      "inverseLabel": "<string>",
      "inverseName": "<string>",
      "isInversePrimary": true,
      "isPrimary": true,
      "label": "<string>",
      "maxFromObjectIds": 123,
      "maxToObjectIds": 123,
      "name": "<string>",
      "portalUniqueIdentifier": "<string>",
      "toObjectType": "ABANDONED_CART",
      "toObjectTypeId": "<string>"
    }
  ],
  "comboEventRules": {
    "composingRules": [
      {
        "count": 123,
        "eventTypeId": "<string>",
        "lookbackWindowDays": 123,
        "propertyFilters": [
          {
            "filterType": "PROPERTY",
            "frameworkFilterId": 123,
            "operation": {
              "defaultValue": "<string>",
              "includeObjectsWithNoValueSet": true,
              "operationType": "<string>",
              "operator": "HAS_EVER_BEEN_EQUAL_TO",
              "operatorName": "<string>",
              "propertyType": "bool",
              "value": true
            },
            "property": "<string>"
          }
        ]
      }
    ],
    "operationType": "AND",
    "ruleBranches": [
      {}
    ]
  },
  "createdAt": "2023-11-07T05:31:56Z",
  "createdUserId": 123,
  "description": "<string>",
  "fullyQualifiedName": "<string>",
  "id": "<string>",
  "labels": {
    "plural": "<string>",
    "singular": "<string>"
  },
  "name": "<string>",
  "objectTypeId": "<string>",
  "primaryObject": "<string>",
  "primaryObjectId": "<string>",
  "properties": [
    {
      "archived": true,
      "archivedAt": "2023-11-07T05:31:56Z",
      "calculated": true,
      "calculationFormula": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "createdUserId": "<string>",
      "dataSensitivity": "highly_sensitive",
      "description": "<string>",
      "displayOrder": 123,
      "externalOptions": true,
      "fieldType": "<string>",
      "formField": true,
      "groupName": "<string>",
      "hasUniqueValue": true,
      "hidden": true,
      "hubspotDefined": true,
      "label": "<string>",
      "modificationMetadata": {
        "archivable": true,
        "readOnlyDefinition": true,
        "readOnlyOptions": true,
        "readOnlyValue": true
      },
      "name": "<string>",
      "options": [
        {
          "description": "<string>",
          "displayOrder": 123,
          "hidden": true,
          "label": "<string>",
          "value": "<string>"
        }
      ],
      "referencedObjectType": "<string>",
      "sensitiveDataCategories": [
        "<string>"
      ],
      "showCurrencySymbol": true,
      "type": "<string>",
      "updatedAt": "2023-11-07T05:31:56Z",
      "updatedUserId": "<string>"
    }
  ],
  "trackingType": "CLICKED_ELEMENT"
}

Unterstützte Produkte

Erfordert eines der folgenden Produkte oder höher.
Marketing HubMarketing Hub -Enterprise
Sales HubSales Hub -Enterprise
Service HubService Hub -Enterprise
Content HubContent Hub -Enterprise
Diese API erfordert einen der folgenden Bereiche:
behavioral_events.event_definitions.read_write

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Body

application/json
label
string
required

Für Menschen lesbares Label für das Event. Wird in HubSpot-UI verwendet.

propertyDefinitions
object[]
required

Liste der benutzerdefinierten Eigenschaften des Events

description
string

Eine Beschreibung des Events, das in HubSpot als Hilfetext angezeigt wird.

name
string

Interner Event-Name. Muss verwendet werden, wenn über die API für Eventdefinitionen auf das Event verwiesen wird. Wird kein Name angegeben, wird ein Name auf der Grundlage des Labels generiert. Der „name“-Wert wird auch verwendet, um automatisch einen „fullyQualifiedName“ für die Eventdefinition zu generieren, den Sie beim Senden von Eventabschlüssen an dieses Event verwenden werden.

primaryObject
string

Der Objekttyp, dem dieses Ereignis zugeordnet werden soll. Kann CONTACT, COMPANY, DEAL oder TICKET sein. Wenn kein primaryObject angegeben, wird das Event standardmäßig CONTACT-Objekten zugeordnet.

Response

successful operation

archived
boolean
required
associations
object[]
required
fullyQualifiedName
string
required
id
string
required
labels
object
required
name
string
required
objectTypeId
string
required
properties
object[]
required
comboEventRules
object
createdAt
string<date-time>
createdUserId
integer
description
string
primaryObject
string
primaryObjectId
string
trackingType
enum<string>
Verfügbare Optionen:
CLICKED_ELEMENT,
COMBO_EVENT,
CUSTOM_SCRIPT,
IMPORT,
MANUAL,
PROPERTY_CHANGE,
VISITED_URL,
WEBHOOK