@walkeros/server-destination-hubspot 3.4.0-next-1776749829492

package/dist/walkerOS.json

@@ -0,0 +1,754 @@
+{
+  "$meta": {
+    "package": "@walkeros/server-destination-hubspot",
+    "version": "3.4.0-next-1776749829492",
+    "type": "destination",
+    "platform": [
+      "server"
+    ],
+    "docs": "https://www.walkeros.io/docs/destinations/server/hubspot",
+    "source": "https://github.com/elbwalker/walkerOS/tree/main/packages/server/destinations/hubspot/src"
+  },
+  "schemas": {
+    "mapping": {
+      "$schema": "http://json-schema.org/draft-07/schema#",
+      "type": "object",
+      "properties": {
+        "eventName": {
+          "type": "string",
+          "description": "Override eventName for this rule. Without the prefix -- just the event name part (e.g. purchase_completed). The eventNamePrefix is prepended automatically."
+        },
+        "identify": {
+          "description": "Per-event contact upsert. Resolves to { email, properties }. Overrides destination-level identify. Use with skip: true on login/identify events."
+        },
+        "properties": {
+          "description": "Additional event properties mapping. Resolved values are merged with defaultProperties and serialized to strings."
+        }
+      },
+      "additionalProperties": false
+    },
+    "settings": {
+      "$schema": "http://json-schema.org/draft-07/schema#",
+      "type": "object",
+      "properties": {
+        "accessToken": {
+          "type": "string",
+          "minLength": 1,
+          "description": "HubSpot private app access token. Create one in HubSpot Settings > Integrations > Private Apps. Requires analytics.behavioral_events.send scope."
+        },
+        "eventNamePrefix": {
+          "type": "string",
+          "minLength": 1,
+          "description": "Fully qualified event name prefix: pe{HubID}_ (e.g. pe12345678_). Find it in HubSpot under Data Management > Custom Events."
+        },
+        "email": {
+          "type": "string",
+          "description": "walkerOS mapping value path to resolve contact email from events (like user.email). Required for contact association."
+        },
+        "objectId": {
+          "type": "string",
+          "description": "walkerOS mapping value path to resolve HubSpot CRM objectId from events. Alternative to email for contact association."
+        },
+        "identify": {
+          "description": "Destination-level contact upsert mapping. Resolves to { email, properties }. Fires contact update on first push and re-fires when values change."
+        },
+        "defaultProperties": {
+          "type": "object",
+          "propertyNames": {
+            "type": "string"
+          },
+          "additionalProperties": {
+            "type": "string"
+          },
+          "description": "Static event properties added to every event occurrence. Useful for hs_touchpoint_source, hs_page_content_type, etc."
+        },
+        "batch": {
+          "type": "boolean",
+          "description": "Use batch API for events (accumulate and flush). Default: false."
+        },
+        "batchSize": {
+          "type": "integer",
+          "exclusiveMinimum": 0,
+          "maximum": 500,
+          "description": "Batch size before auto-flush. Only used when batch: true. Default: 50. Max: 500."
+        }
+      },
+      "required": [
+        "accessToken",
+        "eventNamePrefix"
+      ],
+      "additionalProperties": false
+    }
+  },
+  "examples": {
+    "env": {
+      "push": {
+        "client": {
+          "events": {
+            "send": {
+              "basicApi": {
+                "send": {
+                  "$code": "()=>Promise.resolve()"
+                }
+              },
+              "batchApi": {
+                "send": {
+                  "$code": "()=>Promise.resolve()"
+                }
+              }
+            }
+          },
+          "crm": {
+            "contacts": {
+              "basicApi": {
+                "update": {
+                  "$code": "()=>Promise.resolve()"
+                }
+              }
+            }
+          }
+        }
+      },
+      "simulation": [
+        "call:events.send.basicApi.send",
+        "call:events.send.batchApi.send",
+        "call:crm.contacts.basicApi.update"
+      ]
+    },
+    "step": {
+      "defaultEvent": {
+        "in": {
+          "name": "product view",
+          "data": {
+            "id": "ers",
+            "name": "Everyday Ruck Snack",
+            "color": "black",
+            "size": "l",
+            "price": 420
+          },
+          "context": {
+            "shopping": [
+              "detail",
+              0
+            ]
+          },
+          "globals": {
+            "pagegroup": "shop"
+          },
+          "custom": {
+            "completely": "random"
+          },
+          "user": {
+            "email": "user@example.com"
+          },
+          "nested": [],
+          "consent": {
+            "functional": true
+          },
+          "id": "1700000100-gr0up-1",
+          "trigger": "load",
+          "entity": "product",
+          "action": "view",
+          "timestamp": 1700000100,
+          "timing": 3.14,
+          "group": "gr0up",
+          "count": 1,
+          "version": {
+            "source": "3.4.0-next-1776749829492",
+            "tagging": 1
+          },
+          "source": {
+            "type": "web",
+            "id": "https://localhost:80",
+            "previous_id": "http://remotehost:9001"
+          }
+        },
+        "out": [
+          [
+            "events.send.basicApi.send",
+            {
+              "eventName": "pe12345678_product_view",
+              "email": "user@example.com",
+              "occurredAt": {},
+              "properties": {}
+            }
+          ]
+        ]
+      },
+      "defaultProperties": {
+        "in": {
+          "name": "page view",
+          "data": {
+            "domain": "www.example.com",
+            "title": "walkerOS documentation",
+            "referrer": "https://www.walkeros.io/",
+            "search": "?foo=bar",
+            "hash": "#hash",
+            "id": "/docs/"
+          },
+          "context": {
+            "dev": [
+              "test",
+              1
+            ]
+          },
+          "globals": {
+            "pagegroup": "docs"
+          },
+          "custom": {
+            "completely": "random"
+          },
+          "user": {
+            "email": "user@example.com"
+          },
+          "nested": [
+            {
+              "entity": "child",
+              "data": {
+                "is": "subordinated"
+              },
+              "nested": [],
+              "context": {
+                "element": [
+                  "child",
+                  0
+                ]
+              }
+            }
+          ],
+          "consent": {
+            "functional": true
+          },
+          "id": "1700000102-gr0up-1",
+          "trigger": "load",
+          "entity": "page",
+          "action": "view",
+          "timestamp": 1700000102,
+          "timing": 3.14,
+          "group": "gr0up",
+          "count": 1,
+          "version": {
+            "source": "3.4.0-next-1776749829492",
+            "tagging": 1
+          },
+          "source": {
+            "type": "web",
+            "id": "https://localhost:80",
+            "previous_id": "http://remotehost:9001"
+          }
+        },
+        "settings": {
+          "defaultProperties": {
+            "hs_touchpoint_source": "walkerOS",
+            "hs_page_content_type": "STANDARD_PAGE"
+          }
+        },
+        "out": [
+          [
+            "events.send.basicApi.send",
+            {
+              "eventName": "pe12345678_page_view",
+              "email": "user@example.com",
+              "occurredAt": {},
+              "properties": {
+                "hs_touchpoint_source": "walkerOS",
+                "hs_page_content_type": "STANDARD_PAGE"
+              }
+            }
+          ]
+        ]
+      },
+      "destinationIdentify": {
+        "in": {
+          "name": "page view",
+          "data": {
+            "domain": "www.example.com",
+            "title": "walkerOS documentation",
+            "referrer": "https://www.walkeros.io/",
+            "search": "?foo=bar",
+            "hash": "#hash",
+            "id": "/docs/"
+          },
+          "context": {
+            "dev": [
+              "test",
+              1
+            ]
+          },
+          "globals": {
+            "pagegroup": "docs"
+          },
+          "custom": {
+            "completely": "random"
+          },
+          "user": {
+            "email": "user@example.com",
+            "firstName": "Jane",
+            "lastName": "Doe"
+          },
+          "nested": [
+            {
+              "entity": "child",
+              "data": {
+                "is": "subordinated"
+              },
+              "nested": [],
+              "context": {
+                "element": [
+                  "child",
+                  0
+                ]
+              }
+            }
+          ],
+          "consent": {
+            "functional": true
+          },
+          "id": "1700000103-gr0up-1",
+          "trigger": "load",
+          "entity": "page",
+          "action": "view",
+          "timestamp": 1700000103,
+          "timing": 3.14,
+          "group": "gr0up",
+          "count": 1,
+          "version": {
+            "source": "3.4.0-next-1776749829492",
+            "tagging": 1
+          },
+          "source": {
+            "type": "web",
+            "id": "https://localhost:80",
+            "previous_id": "http://remotehost:9001"
+          }
+        },
+        "settings": {
+          "identify": {
+            "map": {
+              "email": "user.email",
+              "properties": {
+                "map": {
+                  "firstname": "user.firstName",
+                  "lastname": "user.lastName"
+                }
+              }
+            }
+          }
+        },
+        "out": [
+          [
+            "crm.contacts.basicApi.update",
+            "user@example.com",
+            {
+              "properties": {
+                "firstname": "Jane",
+                "lastname": "Doe"
+              }
+            },
+            "email"
+          ],
+          [
+            "events.send.basicApi.send",
+            {
+              "eventName": "pe12345678_page_view",
+              "email": "user@example.com",
+              "occurredAt": {},
+              "properties": {}
+            }
+          ]
+        ]
+      },
+      "mappedEventName": {
+        "in": {
+          "name": "order complete",
+          "data": {
+            "total": 99.5,
+            "currency": "EUR",
+            "id": "ord-123"
+          },
+          "context": {
+            "shopping": [
+              "complete",
+              0
+            ]
+          },
+          "globals": {
+            "pagegroup": "shop"
+          },
+          "custom": {
+            "completely": "random"
+          },
+          "user": {
+            "email": "user@example.com"
+          },
+          "nested": [
+            {
+              "entity": "product",
+              "data": {
+                "id": "ers",
+                "name": "Everyday Ruck Snack",
+                "color": "black",
+                "size": "l",
+                "price": 420
+              },
+              "context": {
+                "shopping": [
+                  "complete",
+                  0
+                ]
+              },
+              "nested": []
+            },
+            {
+              "entity": "product",
+              "data": {
+                "id": "cc",
+                "name": "Cool Cap",
+                "size": "one size",
+                "price": 42
+              },
+              "context": {
+                "shopping": [
+                  "complete",
+                  0
+                ]
+              },
+              "nested": []
+            },
+            {
+              "entity": "gift",
+              "data": {
+                "name": "Surprise"
+              },
+              "context": {
+                "shopping": [
+                  "complete",
+                  0
+                ]
+              },
+              "nested": []
+            }
+          ],
+          "consent": {
+            "functional": true
+          },
+          "id": "1700000101-gr0up-1",
+          "trigger": "load",
+          "entity": "order",
+          "action": "complete",
+          "timestamp": 1700000101,
+          "timing": 3.14,
+          "group": "gr0up",
+          "count": 1,
+          "version": {
+            "source": "3.4.0-next-1776749829492",
+            "tagging": 1
+          },
+          "source": {
+            "type": "web",
+            "id": "https://localhost:80",
+            "previous_id": "http://remotehost:9001"
+          }
+        },
+        "mapping": {
+          "name": "order complete",
+          "settings": {
+            "eventName": "purchase_completed",
+            "properties": {
+              "map": {
+                "revenue": "data.total",
+                "currency": "data.currency",
+                "order_id": "data.id"
+              }
+            }
+          }
+        },
+        "out": [
+          [
+            "events.send.basicApi.send",
+            {
+              "eventName": "pe12345678_purchase_completed",
+              "email": "user@example.com",
+              "occurredAt": {},
+              "properties": {
+                "revenue": "99.5",
+                "currency": "EUR",
+                "order_id": "ord-123"
+              }
+            }
+          ]
+        ]
+      },
+      "noIdentity": {
+        "in": {
+          "name": "product view",
+          "data": {
+            "id": "ers",
+            "name": "Everyday Ruck Snack",
+            "color": "black",
+            "size": "l",
+            "price": 420
+          },
+          "context": {
+            "shopping": [
+              "detail",
+              0
+            ]
+          },
+          "globals": {
+            "pagegroup": "shop"
+          },
+          "custom": {
+            "completely": "random"
+          },
+          "user": {},
+          "nested": [],
+          "consent": {
+            "functional": true
+          },
+          "id": "1700000106-gr0up-1",
+          "trigger": "load",
+          "entity": "product",
+          "action": "view",
+          "timestamp": 1700000106,
+          "timing": 3.14,
+          "group": "gr0up",
+          "count": 1,
+          "version": {
+            "source": "3.4.0-next-1776749829492",
+            "tagging": 1
+          },
+          "source": {
+            "type": "web",
+            "id": "https://localhost:80",
+            "previous_id": "http://remotehost:9001"
+          }
+        },
+        "out": []
+      },
+      "objectIdAssociation": {
+        "in": {
+          "name": "product view",
+          "data": {
+            "id": "ers",
+            "name": "Everyday Ruck Snack",
+            "color": "black",
+            "size": "l",
+            "price": 420
+          },
+          "context": {
+            "shopping": [
+              "detail",
+              0
+            ]
+          },
+          "globals": {
+            "pagegroup": "shop"
+          },
+          "custom": {
+            "completely": "random"
+          },
+          "user": {
+            "id": "hs-contact-789"
+          },
+          "nested": [],
+          "consent": {
+            "functional": true
+          },
+          "id": "1700000105-gr0up-1",
+          "trigger": "load",
+          "entity": "product",
+          "action": "view",
+          "timestamp": 1700000105,
+          "timing": 3.14,
+          "group": "gr0up",
+          "count": 1,
+          "version": {
+            "source": "3.4.0-next-1776749829492",
+            "tagging": 1
+          },
+          "source": {
+            "type": "web",
+            "id": "https://localhost:80",
+            "previous_id": "http://remotehost:9001"
+          }
+        },
+        "settings": {
+          "objectId": "user.id"
+        },
+        "out": [
+          [
+            "events.send.basicApi.send",
+            {
+              "eventName": "pe12345678_product_view",
+              "objectId": "hs-contact-789",
+              "occurredAt": {},
+              "properties": {}
+            }
+          ]
+        ]
+      },
+      "userLoginIdentify": {
+        "in": {
+          "name": "user login",
+          "data": {
+            "email": "login@acme.com",
+            "first_name": "Jane",
+            "last_name": "Doe",
+            "lifecycle": "lead"
+          },
+          "context": {
+            "dev": [
+              "test",
+              1
+            ]
+          },
+          "globals": {
+            "lang": "elb"
+          },
+          "custom": {
+            "completely": "random"
+          },
+          "user": {
+            "email": "user@example.com"
+          },
+          "nested": [
+            {
+              "entity": "child",
+              "data": {
+                "is": "subordinated"
+              },
+              "nested": [],
+              "context": {
+                "element": [
+                  "child",
+                  0
+                ]
+              }
+            }
+          ],
+          "consent": {
+            "functional": true
+          },
+          "id": "1700000104-gr0up-1",
+          "trigger": "test",
+          "entity": "user",
+          "action": "login",
+          "timestamp": 1700000104,
+          "timing": 3.14,
+          "group": "gr0up",
+          "count": 1,
+          "version": {
+            "source": "3.4.0-next-1776749829492",
+            "tagging": 1
+          },
+          "source": {
+            "type": "web",
+            "id": "https://localhost:80",
+            "previous_id": "http://remotehost:9001"
+          }
+        },
+        "mapping": {
+          "skip": true,
+          "settings": {
+            "identify": {
+              "map": {
+                "email": "data.email",
+                "properties": {
+                  "map": {
+                    "firstname": "data.first_name",
+                    "lastname": "data.last_name",
+                    "lifecyclestage": "data.lifecycle"
+                  }
+                }
+              }
+            }
+          }
+        },
+        "out": [
+          [
+            "crm.contacts.basicApi.update",
+            "login@acme.com",
+            {
+              "properties": {
+                "firstname": "Jane",
+                "lastname": "Doe",
+                "lifecyclestage": "lead"
+              }
+            },
+            "email"
+          ]
+        ]
+      },
+      "wildcardIgnored": {
+        "in": {
+          "name": "debug noise",
+          "data": {
+            "string": "foo",
+            "number": 1,
+            "boolean": true,
+            "array": [
+              0,
+              "text",
+              false
+            ]
+          },
+          "context": {
+            "dev": [
+              "test",
+              1
+            ]
+          },
+          "globals": {
+            "lang": "elb"
+          },
+          "custom": {
+            "completely": "random"
+          },
+          "user": {
+            "email": "user@example.com"
+          },
+          "nested": [
+            {
+              "entity": "child",
+              "data": {
+                "is": "subordinated"
+              },
+              "nested": [],
+              "context": {
+                "element": [
+                  "child",
+                  0
+                ]
+              }
+            }
+          ],
+          "consent": {
+            "functional": true
+          },
+          "id": "1700000107-gr0up-1",
+          "trigger": "test",
+          "entity": "debug",
+          "action": "noise",
+          "timestamp": 1700000107,
+          "timing": 3.14,
+          "group": "gr0up",
+          "count": 1,
+          "version": {
+            "source": "3.4.0-next-1776749829492",
+            "tagging": 1
+          },
+          "source": {
+            "type": "web",
+            "id": "https://localhost:80",
+            "previous_id": "http://remotehost:9001"
+          }
+        },
+        "mapping": {
+          "ignore": true
+        },
+        "out": []
+      }
+    }
+  }
+}