POST
/
events
/
v3
/
event-definitions
Créer une définition d'événement personnalisé
curl --request POST \
  --url https://api.hubapi.com/events/v3/event-definitions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "propertyDefinitions": [
    {
      "name": "<string>",
      "options": [
        {
          "hidden": true,
          "displayOrder": 123,
          "description": "<string>",
          "label": "<string>",
          "value": "<string>"
        }
      ],
      "description": "<string>",
      "label": "<string>",
      "type": "<string>"
    }
  ],
  "name": "<string>",
  "description": "<string>",
  "label": "<string>",
  "primaryObject": "<string>"
}'
{
  "associations": [
    {
      "inverseLabel": "",
      "hidden": false,
      "allowsCustomLabels": false,
      "maxFromObjectIds": 123,
      "inverseAllowsCustomLabels": false,
      "isPrimary": false,
      "hasUserEnforcedMaxToObjectIds": false,
      "hasUserEnforcedMaxFromObjectIds": false,
      "id": 123,
      "toObjectTypeId": "",
      "inverseCardinality": "",
      "maxToObjectIds": 123,
      "hasCascadingDeletes": false,
      "fromObjectType": "",
      "toObjectType": "",
      "label": "",
      "inverseId": 123,
      "cardinality": "",
      "inverseName": "",
      "hasAllAssociatedObjects": false,
      "inverseHasAllAssociatedObjects": false,
      "fromObjectTypeId": "",
      "portalUniqueIdentifier": "",
      "isInversePrimary": false,
      "name": "",
      "category": ""
    }
  ],
  "objectTypeId": "<string>",
  "createdUserId": 123,
  "trackingType": "VISITED_URL",
  "description": "<string>",
  "primaryObjectId": "<string>",
  "comboEventRules": {
    "operationType": "AND",
    "composingRules": [
      {
        "lookbackWindowDays": 123,
        "eventTypeId": "<string>",
        "propertyFilters": [
          {
            "frameworkFilterId": 123,
            "property": "<string>",
            "filterType": "PROPERTY",
            "operation": {
              "includeObjectsWithNoValueSet": true,
              "defaultValue": "<string>",
              "propertyType": "bool",
              "operationType": "<string>",
              "value": true,
              "operatorName": "<string>",
              "operator": "IS_EQUAL_TO"
            }
          }
        ],
        "count": 123
      }
    ],
    "ruleBranches": [
      {}
    ]
  },
  "fullyQualifiedName": "<string>",
  "primaryObject": "<string>",
  "labels": {
    "plural": "<string>",
    "singular": "<string>"
  },
  "archived": true,
  "createdAt": "2023-11-07T05:31:56Z",
  "name": "<string>",
  "id": "<string>",
  "properties": [
    {
      "hidden": false,
      "displayOrder": 123,
      "description": "",
      "showCurrencySymbol": false,
      "type": "",
      "hubspotDefined": false,
      "createdAt": "2023-11-07T05:31:56Z",
      "archived": false,
      "options": "",
      "hasUniqueValue": false,
      "calculated": false,
      "externalOptions": false,
      "updatedAt": "2023-11-07T05:31:56Z",
      "createdUserId": "",
      "modificationMetadata": {
        "readOnlyOptions": true,
        "readOnlyValue": true,
        "readOnlyDefinition": true,
        "archivable": true
      },
      "sensitiveDataCategories": "",
      "label": "",
      "formField": false,
      "dataSensitivity": "",
      "archivedAt": "2023-11-07T05:31:56Z",
      "groupName": "",
      "referencedObjectType": "",
      "name": "",
      "calculationFormula": "",
      "fieldType": "",
      "updatedUserId": "<string>"
    }
  ]
}
Produits pris en charge
Exige l'un des produits suivants ou un produit supérieur.
Marketing HubMarketing HubEntreprise
Sales HubSales HubEntreprise
Service HubService HubEntreprise
Content HubContent HubEntreprise

Portées requises

Cette API requiert l’une des portées suivantes :
  • 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
propertyDefinitions
object[]
required

Liste des propriétés personnalisées sur l'événement

label
string
required

Libellé lisible par la personne pour l'événement. Utilisé dans l'IU de HubSpot

name
string

Nom interne de l'événement, qui doit être utilisé pour référencer l'événement à partir de cette API de définitions d'événements. Si aucun nom n'est fourni, un nom sera généré à partir du libellé. La valeur name sera également utilisée pour générer automatiquement un fullyQualifiedName pour la définition de l'événement, que vous utiliserez lorsque vous enverrez des compléments d'événement à cet événement.

description
string

Une description de l'événement qui sera affichée comme texte d'aide dans HubSpot.

primaryObject
string

Le type d'objet à associer à cet événement. Peut être l'un des suivants : CONTACT, ENTREPRISE, TRANSACTION, TICKET. Si aucun primaryObject n'est fourni, nous associerons par défaut l'événement aux objets CONTACT.

Response

successful operation

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