@friggframework/core 2.0.0--canary.690.08cd07e.0 → 2.0.0--canary.693.d8859c2.0

package/integrations/data-defined/examples/records/phone-hubspot.integration.json

@@ -0,0 +1,86 @@
+{
+  "$comment": "Frigg Integration row (existing model). Only `config` is new in shape; everything else is what Frigg stores today.",
+  "id": "int_7f3a9c",
+  "userId": "usr_acme_admin",
+  "status": "ENABLED",
+  "version": "1.4.0",
+  "entities": [
+    {
+      "id": "ent_phone_51",
+      "moduleName": "phone",
+      "externalId": "ws_9a1"
+    },
+    {
+      "id": "ent_hs_88",
+      "moduleName": "hubspot",
+      "externalId": "12345678"
+    }
+  ],
+  "config": {
+    "definition": {
+      "id": "phone-hubspot",
+      "version": "1.4.0",
+      "checksum": "sha256:386c69e18a51a7cf061634309eca3e8267c1a59629a388498eddaad9eb44be59"
+    },
+    "settings": {
+      "fromNumber": "+15125550100"
+    },
+    "syncs": {
+      "contacts": {
+        "enabled": true
+      }
+    },
+    "workflows": {
+      "log-call": {
+        "enabled": true
+      },
+      "call-summary": {
+        "enabled": true
+      },
+      "missed-call-task": {
+        "enabled": true,
+        "settings": {
+          "owner": "81273645",
+          "dueIn": "2h"
+        }
+      },
+      "texts-timeline": {
+        "enabled": true
+      },
+      "won-thank-you": {
+        "enabled": false
+      },
+      "stale-contacts": {
+        "enabled": false
+      },
+      "text-from-card": {
+        "enabled": true
+      }
+    },
+    "ui": {
+      "phone-card": {
+        "enabled": true
+      },
+      "deals-panel": {
+        "enabled": true
+      }
+    },
+    "runtime": {
+      "installed": {
+        "hook": {
+          "id": "WHk2c9",
+          "url": "https://api.example.com/api/data-defined-integration/webhooks/int_7f3a9c?module=phone",
+          "events": [
+            "call.completed",
+            "call.ringing",
+            "call.summary.completed",
+            "message.received",
+            "contact.updated"
+          ]
+        }
+      }
+    }
+  },
+  "createdAt": "2026-09-02T15:20:00Z",
+  "updatedAt": "2026-10-18T09:12:44Z"
+}

package/integrations/data-defined/examples/records/phone-hubspot.mappings.json

@@ -0,0 +1,39 @@
+{
+  "$comment": "IntegrationMapping rows (existing table). link:* = the same record on both sides; idx:* = identity index (normalised email/phone); evt:* = an event already handled (insert-only, so a redelivery is a no-op).",
+  "rows": [
+    {
+      "integrationId": "int_7f3a9c",
+      "sourceId": "idx:contacts:phone:+15125550142",
+      "mapping": {
+        "hubspot": "51",
+        "phone": "CT7",
+        "linkedAt": "2026-09-02T15:31:10Z"
+      }
+    },
+    {
+      "integrationId": "int_7f3a9c",
+      "sourceId": "link:contacts:hubspot:51",
+      "mapping": {
+        "hubspot": "51",
+        "phone": "CT7",
+        "linkedAt": "2026-09-02T15:31:10Z"
+      }
+    },
+    {
+      "integrationId": "int_7f3a9c",
+      "sourceId": "link:contacts:phone:CT7",
+      "mapping": {
+        "hubspot": "51",
+        "phone": "CT7",
+        "linkedAt": "2026-09-02T15:31:10Z"
+      }
+    },
+    {
+      "integrationId": "int_7f3a9c",
+      "sourceId": "evt:phone-hubspot:log-call:EVc0a1",
+      "mapping": {
+        "at": "2026-10-18T16:08:10.523Z"
+      }
+    }
+  ]
+}

package/integrations/data-defined/examples/records/phone-hubspot.workflow-run.json

@@ -0,0 +1,62 @@
+{
+  "$comment": "WorkflowRun row written by the runtime for one delivered Phone call.completed event. `outbound` is the captured HubSpot call (shown here for documentation; production stores a digest).",
+  "id": "run_01JB8A0K",
+  "integrationId": "int_7f3a9c",
+  "definition": {
+    "id": "phone-hubspot",
+    "version": "1.4.0"
+  },
+  "workflowId": "log-call",
+  "trigger": {
+    "type": "webhook",
+    "eventId": "EVc0a1"
+  },
+  "startedAt": "2026-10-18T14:07:13.037Z",
+  "status": "completed",
+  "endedAt": "2026-10-18T14:07:13.074Z",
+  "trace": [
+    {
+      "id": "contact",
+      "use": "links.find",
+      "at": "steps[0]",
+      "status": "ok",
+      "ms": 0
+    },
+    {
+      "id": "stop#1",
+      "use": "stop",
+      "at": "steps[1]",
+      "status": "skipped"
+    },
+    {
+      "id": "body",
+      "use": "template",
+      "at": "steps[2]",
+      "status": "ok",
+      "ms": 2
+    },
+    {
+      "id": "engagement",
+      "use": "hubspot.call.create",
+      "at": "steps[3]",
+      "status": "ok",
+      "ms": 0
+    }
+  ],
+  "outbound": [
+    {
+      "module": "hubspot",
+      "method": "createCallEngagement",
+      "args": {
+        "contactId": "51",
+        "properties": {
+          "hs_call_title": "Phone call (incoming)",
+          "hs_call_body": "Phone call with +15125550142 · 312s (completed)",
+          "hs_call_duration": 312,
+          "hs_call_direction": "INCOMING",
+          "hs_timestamp": "2026-10-18T14:07:12Z"
+        }
+      }
+    }
+  ]
+}

package/integrations/data-defined/examples/shopify-klaviyo.definition.json

@@ -0,0 +1,488 @@
+{
+  "$schema": "https://friggframework.org/schemas/integration-definition/v0.1.json",
+  "schemaVersion": "0.1",
+  "id": "shopify-klaviyo",
+  "version": "1.5.0",
+  "display": {
+    "label": "Shopify \u2192 Klaviyo",
+    "description": "Customers become Klaviyo profiles, and orders, ordered products, abandoned checkouts and fulfillments become Klaviyo events for flows. The Shopify customer page shows the customer's Klaviyo lists.",
+    "category": "Marketing",
+    "tags": [
+      "ecommerce",
+      "email",
+      "events"
+    ]
+  },
+  "modules": {
+    "shopify": {
+      "module": "shopify",
+      "version": "^3.1"
+    },
+    "klaviyo": {
+      "module": "klaviyo",
+      "version": "^1.1"
+    }
+  },
+  "syncs": [
+    {
+      "id": "customers",
+      "label": "Customers",
+      "source": "shopify.customer",
+      "target": "klaviyo.profile",
+      "direction": "one_way",
+      "identity": {
+        "match": [
+          {
+            "source": "email",
+            "target": "attributes.email",
+            "transform": "lowercase",
+            "key": "email"
+          }
+        ]
+      },
+      "mapping": [
+        {
+          "source": "email",
+          "target": "attributes.email",
+          "transform": "lowercase"
+        },
+        {
+          "source": "first_name",
+          "target": "attributes.first_name"
+        },
+        {
+          "source": "last_name",
+          "target": "attributes.last_name"
+        },
+        {
+          "source": "phone",
+          "target": "attributes.phone_number",
+          "transform": "to_e164_phone"
+        },
+        {
+          "source": "default_address.company",
+          "target": "attributes.organization"
+        },
+        {
+          "source": "default_address.city",
+          "target": "attributes.location.city"
+        },
+        {
+          "source": "default_address.province_code",
+          "target": "attributes.location.region"
+        },
+        {
+          "source": "default_address.country_code",
+          "target": "attributes.location.country"
+        },
+        {
+          "source": "default_address.zip",
+          "target": "attributes.location.zip"
+        },
+        {
+          "source": "total_spent",
+          "target": "attributes.properties.lifetime_value",
+          "transform": "number"
+        },
+        {
+          "source": "tags",
+          "target": "attributes.properties.shopify_tags"
+        },
+        {
+          "source": "id",
+          "target": "attributes.external_id"
+        }
+      ],
+      "filter": "$.record.email exists",
+      "backfill": {
+        "trigger": "onInstall",
+        "pageSize": 250
+      },
+      "ongoing": {
+        "mode": "webhook"
+      },
+      "default": "on"
+    }
+  ],
+  "workflows": [
+    {
+      "id": "placed-order",
+      "label": "Placed Order and Ordered Product events",
+      "description": "One \"Placed Order\" event per order and one \"Ordered Product\" per line item, the shape Klaviyo's ecommerce flows expect.",
+      "purpose": "write",
+      "default": "on",
+      "trigger": {
+        "type": "webhook",
+        "module": "shopify",
+        "topic": "order.created",
+        "filter": "$.record.email exists"
+      },
+      "steps": [
+        {
+          "use": "klaviyo.event.create",
+          "with": {
+            "metric": "Placed Order",
+            "profile": {
+              "email": "$.record.email",
+              "external_id": "{{record.customer.id}}"
+            },
+            "properties": {
+              "OrderId": "$.record.id",
+              "OrderNumber": "$.record.name",
+              "Items": "$.record.line_items",
+              "DiscountCodes": "$.record.discount_codes",
+              "SourceName": "$.record.source_name",
+              "ShippingCity": "$.record.shipping_address.city"
+            },
+            "value": "{{record.total_price | number}}",
+            "time": "$.record.created_at",
+            "uniqueId": "order-{{record.id}}"
+          }
+        },
+        {
+          "id": "products",
+          "use": "foreach",
+          "with": {
+            "over": "$.record.line_items",
+            "max": 100
+          },
+          "do": [
+            {
+              "id": "price",
+              "use": "map",
+              "with": {
+                "record": "$.item",
+                "mapping": [
+                  {
+                    "source": "price",
+                    "target": "value",
+                    "transform": "number"
+                  }
+                ]
+              }
+            },
+            {
+              "use": "klaviyo.event.create",
+              "with": {
+                "metric": "Ordered Product",
+                "profile": {
+                  "email": "$.record.email",
+                  "external_id": "{{record.customer.id}}"
+                },
+                "properties": {
+                  "OrderId": "$.record.id",
+                  "ProductID": "$.item.product_id",
+                  "SKU": "$.item.sku",
+                  "ProductName": "$.item.title",
+                  "VariantName": "$.item.variant_title",
+                  "Quantity": "$.item.quantity"
+                },
+                "value": "$.steps.price.value",
+                "time": "$.record.created_at",
+                "uniqueId": "order-{{record.id}}-line-{{item.id}}"
+              }
+            }
+          ]
+        }
+      ]
+    },
+    {
+      "id": "abandoned-checkout",
+      "label": "Started Checkout events for abandoned checkouts",
+      "purpose": "write",
+      "default": "on",
+      "trigger": {
+        "type": "webhook",
+        "module": "shopify",
+        "topic": "checkout.abandoned",
+        "filter": "$.record.email exists && !($.record.completed_at exists)"
+      },
+      "steps": [
+        {
+          "use": "klaviyo.event.create",
+          "with": {
+            "metric": "Started Checkout",
+            "profile": {
+              "email": "$.record.email",
+              "external_id": "{{record.customer.id}}"
+            },
+            "properties": {
+              "CheckoutURL": "$.record.abandoned_checkout_url",
+              "Items": "$.record.line_items",
+              "Currency": "$.record.currency"
+            },
+            "value": "{{record.total_price | number}}",
+            "time": "$.record.created_at",
+            "uniqueId": "checkout-{{record.token}}"
+          }
+        }
+      ]
+    },
+    {
+      "id": "fulfilled-order",
+      "label": "Fulfilled Order events",
+      "purpose": "write",
+      "default": "on",
+      "trigger": {
+        "type": "webhook",
+        "module": "shopify",
+        "topic": "fulfillment.created"
+      },
+      "steps": [
+        {
+          "id": "order",
+          "use": "shopify.order.get",
+          "with": {
+            "id": "$.record.order_id",
+            "fields": "id,name,email,customer,total_price"
+          }
+        },
+        {
+          "use": "stop",
+          "when": "!($.steps.order.email exists)",
+          "with": {
+            "reason": "Order has no email"
+          }
+        },
+        {
+          "use": "klaviyo.event.create",
+          "with": {
+            "metric": "Fulfilled Order",
+            "profile": {
+              "email": "$.steps.order.email",
+              "external_id": "{{steps.order.customer.id}}"
+            },
+            "properties": {
+              "OrderId": "$.steps.order.id",
+              "OrderNumber": "$.steps.order.name",
+              "TrackingCompany": "$.record.tracking_company",
+              "TrackingNumber": "$.record.tracking_number",
+              "TrackingUrl": "$.record.tracking_url"
+            },
+            "time": "$.record.created_at",
+            "uniqueId": "fulfillment-{{record.id}}"
+          }
+        }
+      ]
+    },
+    {
+      "id": "add-to-list",
+      "label": "Subscribe the customer to a Klaviyo list",
+      "purpose": "respond",
+      "default": "on",
+      "settings": {
+        "list": {
+          "type": "option",
+          "options": "klaviyo.list",
+          "label": "List the button subscribes to",
+          "required": true
+        }
+      },
+      "trigger": {
+        "type": "userAction",
+        "label": "Subscribe to list",
+        "from": "klaviyo-block"
+      },
+      "steps": [
+        {
+          "use": "stop",
+          "when": "!($.record.email exists)",
+          "with": {
+            "reason": "Customer has no email"
+          }
+        },
+        {
+          "use": "klaviyo.profile.subscribe",
+          "with": {
+            "listId": "$.settings.list",
+            "email": "$.record.email",
+            "channels": [
+              "email"
+            ]
+          }
+        }
+      ]
+    }
+  ],
+  "queries": [
+    {
+      "id": "klaviyo-profile",
+      "description": "The Klaviyo profile for this Shopify customer and the lists it is on.",
+      "steps": [
+        {
+          "use": "stop",
+          "when": "!($.record.email exists)",
+          "with": {
+            "reason": "Customer has no email"
+          }
+        },
+        {
+          "id": "profiles",
+          "use": "klaviyo.profile.search",
+          "with": {
+            "email": "$.record.email"
+          }
+        },
+        {
+          "use": "stop",
+          "when": "$.steps.profiles[0] == null",
+          "with": {
+            "reason": "No Klaviyo profile"
+          }
+        },
+        {
+          "id": "lists",
+          "use": "klaviyo.profile.lists",
+          "with": {
+            "id": "$.steps.profiles[0].id"
+          }
+        }
+      ],
+      "returns": {
+        "profile": "$.steps.profiles[0]",
+        "lists": "$.steps.lists"
+      }
+    }
+  ],
+  "ui": [
+    {
+      "id": "klaviyo-block",
+      "label": "Klaviyo",
+      "host": "shopify",
+      "placement": "admin.customer-details.block",
+      "objects": [
+        "customer"
+      ],
+      "data": {
+        "query": "klaviyo-profile"
+      },
+      "view": {
+        "component": "Stack",
+        "children": [
+          {
+            "component": "Heading",
+            "props": {
+              "text": "Klaviyo"
+            }
+          },
+          {
+            "component": "Empty",
+            "when": "!($.data.profile exists)",
+            "props": {
+              "text": "No Klaviyo profile for this customer yet."
+            }
+          },
+          {
+            "component": "KeyValue",
+            "when": "$.data.profile exists",
+            "props": {
+              "items": [
+                {
+                  "label": "Email consent",
+                  "value": "{{data.profile.attributes.subscriptions.email.marketing.consent | default: 'NEVER_SUBSCRIBED'}}"
+                },
+                {
+                  "label": "Lifetime value",
+                  "value": "{{data.profile.attributes.properties.lifetime_value | default: 0}}"
+                }
+              ]
+            }
+          },
+          {
+            "component": "List",
+            "props": {
+              "items": "$.data.lists",
+              "title": "{{item.attributes.name}}",
+              "meta": "since {{item.attributes.created | date}}"
+            }
+          },
+          {
+            "component": "Button",
+            "props": {
+              "label": "Subscribe to list",
+              "action": {
+                "type": "userAction",
+                "workflow": "add-to-list"
+              }
+            }
+          },
+          {
+            "component": "Button",
+            "when": "$.data.profile exists",
+            "props": {
+              "label": "Open in Klaviyo",
+              "action": {
+                "type": "open_url",
+                "url": "https://www.klaviyo.com/profile/{{data.profile.id}}"
+              }
+            }
+          }
+        ]
+      }
+    }
+  ],
+  "lifecycle": {
+    "onInstall": [
+      {
+        "use": "shopify.webhook.create",
+        "with": {
+          "topic": "orders/create",
+          "address": "$.install.webhookUrls.shopify",
+          "format": "json"
+        },
+        "id": "hook-orders-create"
+      },
+      {
+        "use": "shopify.webhook.create",
+        "with": {
+          "topic": "fulfillments/create",
+          "address": "$.install.webhookUrls.shopify",
+          "format": "json"
+        },
+        "id": "hook-fulfillments-create"
+      },
+      {
+        "use": "shopify.webhook.create",
+        "with": {
+          "topic": "customers/create",
+          "address": "$.install.webhookUrls.shopify",
+          "format": "json"
+        },
+        "id": "hook-customers-create"
+      },
+      {
+        "use": "shopify.webhook.create",
+        "with": {
+          "topic": "customers/update",
+          "address": "$.install.webhookUrls.shopify",
+          "format": "json"
+        },
+        "id": "hook-customers-update"
+      }
+    ],
+    "onUninstall": [
+      {
+        "id": "unhook",
+        "use": "foreach",
+        "with": {
+          "over": [
+            "$.install.runtime.installed.hook-orders-create.id",
+            "$.install.runtime.installed.hook-fulfillments-create.id",
+            "$.install.runtime.installed.hook-customers-create.id",
+            "$.install.runtime.installed.hook-customers-update.id"
+          ],
+          "max": 20
+        },
+        "do": [
+          {
+            "use": "shopify.webhook.delete",
+            "with": {
+              "id": "$.item"
+            },
+            "onError": "continue"
+          }
+        ]
+      }
+    ]
+  }
+}