@friggframework/core 2.0.0--canary.703.12b980b.0 → 2.0.0--canary.707.df80bfd.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (308) hide show
  1. package/CHANGELOG.md +11 -0
  2. package/CLAUDE.md +28 -0
  3. package/README.md +105 -0
  4. package/application/commands/integration-commands.js +20 -10
  5. package/application/commands/scheduler-commands.js +11 -7
  6. package/application/commands/user-commands.js +17 -5
  7. package/application/index.js +6 -2
  8. package/core/Worker.js +31 -7
  9. package/core/create-handler.js +9 -0
  10. package/credential/repositories/credential-repository-documentdb.js +34 -0
  11. package/credential/repositories/credential-repository-interface.js +15 -0
  12. package/credential/repositories/credential-repository-mongo.js +23 -0
  13. package/credential/repositories/credential-repository-postgres.js +28 -0
  14. package/credential/use-cases/credential-operations-for-user.js +202 -0
  15. package/credential/use-cases/reauthorize-credential-for-user.js +73 -0
  16. package/database/config.js +48 -24
  17. package/database/documentdb-encryption-service.js +9 -22
  18. package/database/documentdb-utils.js +2 -2
  19. package/database/encryption/README.md +78 -14
  20. package/database/encryption/documentdb-encryption-service.md +78 -1
  21. package/database/encryption/encryption-config.js +219 -0
  22. package/database/encryption/encryption-schema-registry.js +121 -24
  23. package/database/encryption/field-encryption-service.js +69 -5
  24. package/database/encryption/integration-mapping-encryption.js +1 -1
  25. package/database/encryption/test-support/fake-ciphertext.js +15 -0
  26. package/database/organization-where.js +18 -0
  27. package/database/prisma.js +15 -38
  28. package/database/unique-violation.js +25 -0
  29. package/database/use-cases/check-encryption-health-use-case.js +43 -52
  30. package/errors/index.js +0 -4
  31. package/extensions/bootstrap-runner.js +43 -0
  32. package/extensions/extension-loader.js +230 -0
  33. package/extensions/index.js +44 -0
  34. package/extensions/initialize-app.js +123 -0
  35. package/extensions/prisma-composer.js +270 -0
  36. package/extensions/route-mounter.js +103 -0
  37. package/extensions/schema-composer.js +188 -0
  38. package/generated/prisma-mongodb/edge.js +33 -42
  39. package/generated/prisma-mongodb/index-browser.js +30 -39
  40. package/generated/prisma-mongodb/index.d.ts +3187 -2005
  41. package/generated/prisma-mongodb/index.js +33 -42
  42. package/generated/prisma-mongodb/package.json +1 -1
  43. package/generated/prisma-mongodb/schema.prisma +86 -59
  44. package/generated/prisma-mongodb/wasm.js +33 -42
  45. package/generated/prisma-postgresql/edge.js +33 -42
  46. package/generated/prisma-postgresql/index-browser.js +30 -39
  47. package/generated/prisma-postgresql/index.d.ts +3380 -2177
  48. package/generated/prisma-postgresql/index.js +33 -42
  49. package/generated/prisma-postgresql/package.json +1 -1
  50. package/generated/prisma-postgresql/schema.prisma +81 -57
  51. package/generated/prisma-postgresql/wasm.js +33 -42
  52. package/handlers/WEBHOOKS.md +0 -29
  53. package/handlers/app-definition-loader.js +128 -19
  54. package/handlers/app-handler-helpers.js +27 -8
  55. package/handlers/backend-utils.js +31 -25
  56. package/handlers/integration-event-dispatcher.js +3 -7
  57. package/handlers/middleware/admin-auth.js +14 -1
  58. package/handlers/routers/auth.js +46 -10
  59. package/handlers/routers/health.js +13 -4
  60. package/handlers/routers/integration-defined-routers.js +144 -92
  61. package/handlers/routers/integration-webhook-routers.js +100 -50
  62. package/handlers/workers/integration-defined-workers.js +5 -2
  63. package/index.js +66 -16
  64. package/infrastructure/scheduler/index.js +19 -6
  65. package/infrastructure/scheduler/netlify-scheduler-adapter.js +216 -0
  66. package/infrastructure/scheduler/scheduled-job-repository.js +118 -0
  67. package/infrastructure/scheduler/scheduler-service-factory.js +55 -7
  68. package/integrations/index.js +1 -14
  69. package/integrations/integration-base.js +2 -163
  70. package/integrations/integration-router.js +132 -102
  71. package/integrations/repositories/integration-mapping-repository-documentdb.js +0 -50
  72. package/integrations/repositories/integration-mapping-repository-interface.js +0 -15
  73. package/integrations/repositories/integration-mapping-repository-mongo.js +0 -29
  74. package/integrations/repositories/integration-mapping-repository-postgres.js +0 -30
  75. package/integrations/repositories/integration-mapping-repository.js +0 -29
  76. package/integrations/repositories/integration-not-found.js +14 -0
  77. package/integrations/repositories/integration-repository-documentdb.js +37 -9
  78. package/integrations/repositories/integration-repository-interface.js +17 -4
  79. package/integrations/repositories/integration-repository-mongo.js +64 -96
  80. package/integrations/repositories/integration-repository-postgres.js +63 -81
  81. package/integrations/repositories/process-repository-mongo.js +1 -1
  82. package/integrations/schedule-config.js +80 -0
  83. package/integrations/tests/doubles/test-integration-repository.js +12 -1
  84. package/integrations/use-cases/create-integration.js +56 -31
  85. package/integrations/use-cases/delete-integration-for-user.js +4 -4
  86. package/integrations/use-cases/dispatch-ongoing-syncs.js +100 -0
  87. package/integrations/use-cases/get-integration-for-user.js +2 -4
  88. package/integrations/use-cases/get-integration-instance.js +4 -4
  89. package/integrations/use-cases/get-integrations-for-user.js +79 -39
  90. package/integrations/use-cases/get-possible-integrations.js +2 -7
  91. package/integrations/use-cases/index.js +7 -1
  92. package/integrations/use-cases/integration-operations-for-user.js +256 -0
  93. package/integrations/use-cases/resolve-integration-ownership.js +177 -0
  94. package/integrations/use-cases/update-integration.js +4 -4
  95. package/integrations/utils/map-integration-dto.js +43 -14
  96. package/management-api/create-management-api-router.js +49 -0
  97. package/management-api/error-response.js +116 -0
  98. package/management-api/management-api-config.js +151 -0
  99. package/management-api/meta-router.js +76 -0
  100. package/management-api/openapi/build-openapi.js +144 -0
  101. package/management-api/openapi/components.js +415 -0
  102. package/management-api/openapi/v1-operations.js +83 -0
  103. package/management-api/openapi/v2-operations.js +264 -0
  104. package/management-api/route-registry.js +411 -0
  105. package/management-api/test-support/http-client.js +39 -0
  106. package/management-api/use-cases/get-management-api-meta.js +57 -0
  107. package/management-api/v1-deprecation.js +120 -0
  108. package/management-api/v2/create-v2-router.js +85 -0
  109. package/management-api/v2/dependencies.js +281 -0
  110. package/management-api/v2/dto.js +143 -0
  111. package/management-api/v2/handlers/authorization.js +94 -0
  112. package/management-api/v2/handlers/credentials.js +33 -0
  113. package/management-api/v2/handlers/entities.js +77 -0
  114. package/management-api/v2/handlers/integrations.js +128 -0
  115. package/management-api/v2/handlers/proxy.js +34 -0
  116. package/management-api/v2/request.js +85 -0
  117. package/management-api/v2/test-support/fake-dependencies.js +103 -0
  118. package/modules/domain/authorization-session.js +144 -0
  119. package/modules/entity-scope.js +15 -0
  120. package/modules/entity-type-registry.js +311 -0
  121. package/modules/index.js +14 -0
  122. package/modules/module-factory.js +12 -0
  123. package/modules/module.js +53 -2
  124. package/modules/proxy/proxy-bases.js +169 -0
  125. package/modules/proxy/proxy-errors.js +31 -0
  126. package/modules/proxy/proxy-path.js +183 -0
  127. package/modules/proxy/proxy-policy.js +277 -0
  128. package/modules/repositories/authorization-session-repository-documentdb.js +112 -0
  129. package/modules/repositories/authorization-session-repository-factory.js +31 -0
  130. package/modules/repositories/authorization-session-repository-interface.js +47 -0
  131. package/modules/repositories/authorization-session-repository-prisma.js +87 -0
  132. package/modules/repositories/entity-not-found.js +18 -0
  133. package/modules/repositories/module-repository-documentdb.js +51 -6
  134. package/modules/repositories/module-repository-interface.js +19 -2
  135. package/modules/repositories/module-repository-mongo.js +67 -74
  136. package/modules/repositories/module-repository-postgres.js +66 -74
  137. package/modules/repositories/module-repository.js +2 -1
  138. package/modules/requester/proxy-request.js +245 -0
  139. package/modules/requester/requester.js +35 -5
  140. package/modules/scope-config.js +192 -0
  141. package/modules/scope-policy.js +112 -0
  142. package/modules/scope-resolution.js +288 -0
  143. package/modules/scope-visibility.js +247 -0
  144. package/modules/tests/doubles/in-memory-authorization-session-repository.js +45 -0
  145. package/modules/tests/doubles/ownership-matching.js +18 -0
  146. package/modules/use-cases/authorize-entity-for-user.js +61 -0
  147. package/modules/use-cases/create-entity-from-credential.js +113 -0
  148. package/modules/use-cases/entity-operations-for-user.js +162 -0
  149. package/modules/use-cases/entity-types.js +139 -0
  150. package/modules/use-cases/execute-entity-proxy-request.js +331 -0
  151. package/modules/use-cases/get-authorization-requirements.js +100 -0
  152. package/modules/use-cases/get-entities-for-user.js +26 -13
  153. package/modules/use-cases/get-entity-module-for-user.js +113 -0
  154. package/modules/use-cases/get-entity-options-by-id.js +10 -4
  155. package/modules/use-cases/get-entity-options-by-type.js +1 -1
  156. package/modules/use-cases/get-module-instance-from-type.js +1 -1
  157. package/modules/use-cases/get-module.js +10 -4
  158. package/modules/use-cases/manage-access.js +21 -0
  159. package/modules/use-cases/multi-step-authorization.js +329 -0
  160. package/modules/use-cases/process-authorization-callback.js +53 -19
  161. package/modules/use-cases/refresh-entity-options.js +10 -4
  162. package/modules/use-cases/test-module-auth.js +10 -4
  163. package/package.json +6 -7
  164. package/prisma-mongodb/schema.prisma +86 -59
  165. package/prisma-postgresql/migrations/20261003000000_add_authorization_session/migration.sql +28 -0
  166. package/prisma-postgresql/migrations/20261015000000_add_organization_membership/migration.sql +26 -0
  167. package/prisma-postgresql/migrations/20261016000000_add_entity_integration_organization/migration.sql +25 -0
  168. package/prisma-postgresql/migrations/20261017000000_add_scheduled_job/migration.sql +28 -0
  169. package/prisma-postgresql/schema.prisma +81 -57
  170. package/providers/index.js +23 -0
  171. package/providers/resolve-provider.js +93 -0
  172. package/providers/runtime-detection.js +124 -0
  173. package/queues/index.js +25 -0
  174. package/queues/providers/index.js +11 -0
  175. package/queues/providers/netlify-background-provider.js +150 -0
  176. package/queues/providers/qstash-queue-provider.js +219 -0
  177. package/queues/providers/sqs-queue-provider.js +70 -0
  178. package/queues/queue-client-interface.js +55 -0
  179. package/queues/queue-message-auth.js +193 -0
  180. package/queues/queue-provider-factory.js +101 -0
  181. package/queues/queue-provider.js +65 -0
  182. package/queues/queuer-util.js +2 -9
  183. package/queues/sqs-queue-client.js +81 -0
  184. package/types/index.d.ts +2 -0
  185. package/types/modules/index.d.ts +214 -0
  186. package/types/user/index.d.ts +134 -0
  187. package/user/adopter-jwt-config.js +177 -0
  188. package/user/adopter-jwt-errors.js +59 -0
  189. package/user/adopter-token-verifier.js +122 -0
  190. package/user/app-user-helpers.js +97 -0
  191. package/user/create-user-authentication.js +64 -0
  192. package/user/membership.js +51 -0
  193. package/user/repositories/organization-membership-record.js +19 -0
  194. package/user/repositories/organization-membership-repository-documentdb.js +106 -0
  195. package/user/repositories/organization-membership-repository-factory.js +42 -0
  196. package/user/repositories/organization-membership-repository-interface.js +57 -0
  197. package/user/repositories/organization-membership-repository-mongo.js +13 -0
  198. package/user/repositories/organization-membership-repository-postgres.js +29 -0
  199. package/user/repositories/organization-membership-repository-prisma.js +81 -0
  200. package/user/repositories/user-repository-documentdb.js +27 -2
  201. package/user/repositories/user-repository-interface.js +18 -0
  202. package/user/repositories/user-repository-mongo.js +24 -0
  203. package/user/repositories/user-repository-postgres.js +18 -0
  204. package/user/tests/doubles/adopter-jwt-fixtures.js +220 -0
  205. package/user/use-cases/authenticate-user.js +7 -1
  206. package/user/use-cases/ensure-organization-membership.js +92 -0
  207. package/user/use-cases/find-individual-users-by-organization.js +54 -0
  208. package/user/use-cases/get-user-from-adopter-jwt.js +95 -124
  209. package/user/use-cases/get-user-from-x-frigg-headers.js +83 -80
  210. package/user/user.js +64 -1
  211. package/errors/mapping-already-exists-error.js +0 -14
  212. package/handlers/workers/integration-triggers.js +0 -25
  213. package/infrastructure/scheduler/recurrence.js +0 -204
  214. package/integrations/define/DESIGN.md +0 -122
  215. package/integrations/define/config.js +0 -98
  216. package/integrations/define/define-app.js +0 -66
  217. package/integrations/define/define-extension.js +0 -154
  218. package/integrations/define/define-integration.js +0 -335
  219. package/integrations/define/examples/deal-alerts.js +0 -140
  220. package/integrations/define/extension-binding.js +0 -174
  221. package/integrations/define/index.js +0 -11
  222. package/integrations/define/json-schema-lite.js +0 -68
  223. package/integrations/define/subscriptions.js +0 -186
  224. package/integrations/define/tests/fixtures/hubspot.js +0 -109
  225. package/integrations/define/tests/fixtures/slack.js +0 -26
  226. package/integrations/define/use.js +0 -39
  227. package/integrations/definitions/README.md +0 -278
  228. package/integrations/definitions/canonical.js +0 -11
  229. package/integrations/definitions/capabilities/AUDIT.md +0 -480
  230. package/integrations/definitions/capabilities/acmeerp.capabilities.json +0 -633
  231. package/integrations/definitions/capabilities/asana.capabilities.json +0 -279
  232. package/integrations/definitions/capabilities/calendly.capabilities.json +0 -385
  233. package/integrations/definitions/capabilities/docusign.capabilities.json +0 -314
  234. package/integrations/definitions/capabilities/fathom.capabilities.json +0 -238
  235. package/integrations/definitions/capabilities/github.capabilities.json +0 -585
  236. package/integrations/definitions/capabilities/hubspot.capabilities.json +0 -822
  237. package/integrations/definitions/capabilities/jira.capabilities.json +0 -391
  238. package/integrations/definitions/capabilities/klaviyo.capabilities.json +0 -503
  239. package/integrations/definitions/capabilities/linear.capabilities.json +0 -378
  240. package/integrations/definitions/capabilities/netsuite.capabilities.json +0 -535
  241. package/integrations/definitions/capabilities/notion.capabilities.json +0 -208
  242. package/integrations/definitions/capabilities/phone.capabilities.json +0 -511
  243. package/integrations/definitions/capabilities/pipedrive.capabilities.json +0 -430
  244. package/integrations/definitions/capabilities/quickbooks.capabilities.json +0 -635
  245. package/integrations/definitions/capabilities/salesforce.capabilities.json +0 -568
  246. package/integrations/definitions/capabilities/shopify.capabilities.json +0 -1128
  247. package/integrations/definitions/capabilities/slack.capabilities.json +0 -373
  248. package/integrations/definitions/capabilities/stripe.capabilities.json +0 -630
  249. package/integrations/definitions/capabilities/webflow.capabilities.json +0 -196
  250. package/integrations/definitions/capabilities/zendesk.capabilities.json +0 -422
  251. package/integrations/definitions/compile.js +0 -80
  252. package/integrations/definitions/config-form.js +0 -137
  253. package/integrations/definitions/examples/acme-erp-quickbooks.definition.json +0 -467
  254. package/integrations/definitions/examples/asana-slack.definition.json +0 -219
  255. package/integrations/definitions/examples/calendly-salesforce.definition.json +0 -459
  256. package/integrations/definitions/examples/docusign-salesforce.definition.json +0 -305
  257. package/integrations/definitions/examples/fathom-hubspot-notion.definition.json +0 -575
  258. package/integrations/definitions/examples/github-linear.definition.json +0 -322
  259. package/integrations/definitions/examples/hubspot-slack.definition.json +0 -427
  260. package/integrations/definitions/examples/klaviyo-hubspot.definition.json +0 -336
  261. package/integrations/definitions/examples/phone-hubspot.definition.json +0 -633
  262. package/integrations/definitions/examples/pipedrive-hubspot.definition.json +0 -136
  263. package/integrations/definitions/examples/pipedrive-phone.definition.json +0 -340
  264. package/integrations/definitions/examples/records/phone-hubspot.definition-version.json +0 -652
  265. package/integrations/definitions/examples/records/phone-hubspot.integration.json +0 -86
  266. package/integrations/definitions/examples/records/phone-hubspot.mappings.json +0 -39
  267. package/integrations/definitions/examples/records/phone-hubspot.workflow-run.json +0 -62
  268. package/integrations/definitions/examples/shopify-klaviyo.definition.json +0 -488
  269. package/integrations/definitions/examples/shopify-netsuite.definition.json +0 -622
  270. package/integrations/definitions/examples/stripe-quickbooks.definition.json +0 -476
  271. package/integrations/definitions/examples/webflow-hubspot-slack.definition.json +0 -262
  272. package/integrations/definitions/examples/zendesk-jira.definition.json +0 -604
  273. package/integrations/definitions/expressions.js +0 -229
  274. package/integrations/definitions/index.js +0 -48
  275. package/integrations/definitions/integration-runtime.js +0 -779
  276. package/integrations/definitions/interpreter.js +0 -104
  277. package/integrations/definitions/manifests.js +0 -177
  278. package/integrations/definitions/renderers/common.js +0 -67
  279. package/integrations/definitions/renderers/html.js +0 -129
  280. package/integrations/definitions/renderers/hubspot.js +0 -59
  281. package/integrations/definitions/renderers/preview.js +0 -154
  282. package/integrations/definitions/renderers/slack.js +0 -146
  283. package/integrations/definitions/repositories/definition-version-repository.js +0 -67
  284. package/integrations/definitions/repositories/workflow-run-repository.js +0 -80
  285. package/integrations/definitions/router.js +0 -170
  286. package/integrations/definitions/runtime.js +0 -268
  287. package/integrations/definitions/schema/capability-manifest.v0.1.schema.json +0 -549
  288. package/integrations/definitions/schema/installation.v0.1.schema.json +0 -130
  289. package/integrations/definitions/schema/integration-definition.v0.1.schema.json +0 -909
  290. package/integrations/definitions/schema/records.md +0 -105
  291. package/integrations/definitions/schema-check.js +0 -58
  292. package/integrations/definitions/scripts/check-manifests.js +0 -220
  293. package/integrations/definitions/scripts/validate.js +0 -66
  294. package/integrations/definitions/steps.js +0 -123
  295. package/integrations/definitions/sync-engine.js +0 -297
  296. package/integrations/definitions/tests/helpers-fake-crm.js +0 -49
  297. package/integrations/definitions/transforms.js +0 -91
  298. package/integrations/definitions/use-cases/definition-use-cases.js +0 -245
  299. package/integrations/definitions/validate.js +0 -436
  300. package/integrations/definitions/versioning.js +0 -176
  301. package/integrations/definitions/webhooks.js +0 -119
  302. package/integrations/integration-types.js +0 -73
  303. package/integrations/triggers.js +0 -244
  304. package/integrations/use-cases/run-trigger-tick.js +0 -155
  305. package/integrations/use-cases/run-trigger.js +0 -77
  306. package/prisma-postgresql/migrations/20261018000000_add_data_defined_integrations/migration.sql +0 -66
  307. package/prisma-postgresql/migrations/20261019000000_workflow_run_waits/migration.sql +0 -7
  308. package/prisma-postgresql/migrations/20261019120000_definition_workspace/migration.sql +0 -5
@@ -1,503 +0,0 @@
1
- {
2
- "$schema": "https://friggframework.org/schemas/capability-manifest/v0.1.json",
3
- "module": "klaviyo",
4
- "label": "Klaviyo",
5
- "package": "@friggframework/api-module-klaviyo",
6
- "version": "1.1.0",
7
- "auth": "oauth2",
8
- "objects": {
9
- "profile": {
10
- "label": "Profile",
11
- "fields": [
12
- {
13
- "name": "id",
14
- "type": "id",
15
- "readOnly": true
16
- },
17
- {
18
- "name": "attributes.email",
19
- "type": "email",
20
- "tag": "contact.email"
21
- },
22
- {
23
- "name": "attributes.phone_number",
24
- "type": "phone",
25
- "tag": "contact.phone"
26
- },
27
- {
28
- "name": "attributes.first_name",
29
- "type": "string",
30
- "tag": "person.givenName"
31
- },
32
- {
33
- "name": "attributes.last_name",
34
- "type": "string",
35
- "tag": "person.familyName"
36
- },
37
- {
38
- "name": "attributes.organization",
39
- "type": "string",
40
- "tag": "organization.name"
41
- },
42
- {
43
- "name": "attributes.title",
44
- "type": "string",
45
- "tag": "person.jobTitle"
46
- },
47
- {
48
- "name": "attributes.external_id",
49
- "type": "string",
50
- "tag": "record.externalId"
51
- },
52
- {
53
- "name": "attributes.location.city",
54
- "type": "string",
55
- "tag": "address.locality"
56
- },
57
- {
58
- "name": "attributes.location.region",
59
- "type": "string",
60
- "tag": "address.region"
61
- },
62
- {
63
- "name": "attributes.location.country",
64
- "type": "string",
65
- "tag": "address.country"
66
- },
67
- {
68
- "name": "attributes.location.zip",
69
- "type": "string",
70
- "tag": "address.postalCode"
71
- },
72
- {
73
- "name": "attributes.subscriptions.email.marketing.consent",
74
- "type": "enum",
75
- "tag": "contact.emailConsent",
76
- "values": [
77
- "SUBSCRIBED",
78
- "UNSUBSCRIBED",
79
- "NEVER_SUBSCRIBED"
80
- ],
81
- "readOnly": true
82
- },
83
- {
84
- "name": "attributes.properties.lifetime_value",
85
- "type": "number",
86
- "tag": "customer.lifetimeValue"
87
- },
88
- {
89
- "name": "attributes.properties.shopify_tags",
90
- "type": "string",
91
- "tag": "record.tags"
92
- },
93
- {
94
- "name": "attributes.properties.hubspot_lifecycle_stage",
95
- "type": "string",
96
- "tag": "contact.lifecycleStage"
97
- },
98
- {
99
- "name": "attributes.created",
100
- "type": "datetime",
101
- "tag": "record.createdAt",
102
- "readOnly": true
103
- },
104
- {
105
- "name": "attributes.updated",
106
- "type": "datetime",
107
- "tag": "record.updatedAt",
108
- "readOnly": true
109
- }
110
- ],
111
- "sync": {
112
- "id": "id",
113
- "updatedAt": "attributes.updated",
114
- "list": {
115
- "capability": "profile.list",
116
- "cursor": "pageCursor",
117
- "limit": "pageSize",
118
- "since": "updatedSince",
119
- "items": "data",
120
- "next": "links.next"
121
- },
122
- "get": {
123
- "capability": "profile.get",
124
- "id": "id"
125
- },
126
- "search": {
127
- "capability": "profile.search"
128
- },
129
- "create": {
130
- "capability": "profile.create",
131
- "body": "attributes"
132
- },
133
- "update": {
134
- "capability": "profile.update",
135
- "id": "id",
136
- "body": "attributes"
137
- }
138
- }
139
- },
140
- "list": {
141
- "label": "List",
142
- "fields": [
143
- {
144
- "name": "id",
145
- "type": "id",
146
- "readOnly": true
147
- },
148
- {
149
- "name": "attributes.name",
150
- "type": "string",
151
- "tag": "list.name"
152
- },
153
- {
154
- "name": "attributes.created",
155
- "type": "datetime",
156
- "readOnly": true
157
- }
158
- ]
159
- },
160
- "event": {
161
- "label": "Event",
162
- "fields": [
163
- {
164
- "name": "id",
165
- "type": "id",
166
- "readOnly": true
167
- },
168
- {
169
- "name": "attributes.metric_name",
170
- "type": "string"
171
- },
172
- {
173
- "name": "attributes.properties",
174
- "type": "json"
175
- },
176
- {
177
- "name": "attributes.value",
178
- "type": "number"
179
- },
180
- {
181
- "name": "attributes.time",
182
- "type": "datetime"
183
- },
184
- {
185
- "name": "attributes.unique_id",
186
- "type": "string"
187
- }
188
- ]
189
- }
190
- },
191
- "events": {
192
- "list.subscribed": {
193
- "delivery": "webhook",
194
- "object": "profile",
195
- "subscribe": "webhook.create",
196
- "description": "Webhook topic event:klaviyo.subscribed_to_list. $.record is the profile; the list is in data.attributes.event_properties.",
197
- "payload": {
198
- "id": "01JAEXAMPLE7Q9VK3D6M2N8P4R",
199
- "topic": "event:klaviyo.subscribed_to_list",
200
- "created_at": "2026-10-18T16:02:11Z",
201
- "data": {
202
- "type": "event",
203
- "id": "4vRpBT",
204
- "attributes": {
205
- "metric_name": "Subscribed to List",
206
- "datetime": "2026-10-18T16:02:10Z",
207
- "event_properties": {
208
- "list_id": "Y6nRLr",
209
- "List": "VIP Customers",
210
- "method": "Shopify"
211
- }
212
- },
213
- "profile": {
214
- "type": "profile",
215
- "id": "01HV6N2Y4K9JQ3ZB8XWQ7T5R2M",
216
- "email": "dana.reyes@example.com",
217
- "phone_number": "+15125550142",
218
- "first_name": "Dana",
219
- "last_name": "Reyes",
220
- "organization": "Reyes Coffee Co",
221
- "external_id": "7012345678901"
222
- }
223
- }
224
- },
225
- "record": "data.profile",
226
- "match": "event:klaviyo.subscribed_to_list"
227
- },
228
- "profile.unsubscribed": {
229
- "delivery": "webhook",
230
- "object": "profile",
231
- "subscribe": "webhook.create",
232
- "description": "Webhook topic event:klaviyo.unsubscribed (email marketing). Global unsubscribe, not one list.",
233
- "payload": {
234
- "id": "01JAEXAMPLE7Q9VK3D6M2N8P4R",
235
- "topic": "event:klaviyo.unsubscribed",
236
- "created_at": "2026-10-18T16:02:11Z",
237
- "data": {
238
- "type": "event",
239
- "id": "4vRpBT",
240
- "attributes": {
241
- "metric_name": "Unsubscribed",
242
- "datetime": "2026-10-18T16:02:10Z",
243
- "event_properties": {
244
- "channel": "email",
245
- "method": "Unsubscribe link"
246
- }
247
- },
248
- "profile": {
249
- "type": "profile",
250
- "id": "01HV6N2Y4K9JQ3ZB8XWQ7T5R2M",
251
- "email": "dana.reyes@example.com",
252
- "phone_number": "+15125550142",
253
- "first_name": "Dana",
254
- "last_name": "Reyes",
255
- "organization": "Reyes Coffee Co",
256
- "external_id": "7012345678901"
257
- }
258
- }
259
- },
260
- "record": "data.profile",
261
- "match": "event:klaviyo.unsubscribed"
262
- },
263
- "profile.updated": {
264
- "delivery": "poll",
265
- "object": "profile",
266
- "description": "Polled from GET /api/profiles?filter=greater-than(updated,<cursor>).",
267
- "payload": {
268
- "type": "profile",
269
- "id": "01HV6N2Y4K9JQ3ZB8XWQ7T5R2M",
270
- "attributes": {
271
- "email": "dana.reyes@example.com",
272
- "first_name": "Dana",
273
- "last_name": "Reyes",
274
- "updated": "2026-10-18T17:00:00Z"
275
- }
276
- }
277
- }
278
- },
279
- "webhook": {
280
- "scope": "installation",
281
- "topic": "{{body.topic}}",
282
- "eventId": "{{body.id}}",
283
- "verify": "verifyWebhookSignature"
284
- },
285
- "capabilities": {
286
- "profile.get": {
287
- "kind": "read",
288
- "method": "getProfile",
289
- "input": {
290
- "id": {
291
- "type": "string",
292
- "required": true
293
- },
294
- "additionalFields": {
295
- "type": "array"
296
- }
297
- },
298
- "output": "profile"
299
- },
300
- "profile.search": {
301
- "kind": "search",
302
- "method": "getProfiles",
303
- "input": {
304
- "email": {
305
- "type": "string"
306
- },
307
- "phone_number": {
308
- "type": "string"
309
- },
310
- "external_id": {
311
- "type": "string"
312
- }
313
- },
314
- "output": "profile[]"
315
- },
316
- "profile.list": {
317
- "kind": "read",
318
- "method": "listProfiles",
319
- "input": {
320
- "updatedSince": {
321
- "type": "string"
322
- },
323
- "pageCursor": {
324
- "type": "string"
325
- },
326
- "pageSize": {
327
- "type": "number"
328
- }
329
- },
330
- "output": "page<profile>"
331
- },
332
- "profile.create": {
333
- "kind": "write",
334
- "method": "createProfile",
335
- "input": {
336
- "attributes": {
337
- "type": "object",
338
- "required": true
339
- }
340
- },
341
- "output": "profile"
342
- },
343
- "profile.update": {
344
- "kind": "write",
345
- "method": "updateProfile",
346
- "input": {
347
- "id": {
348
- "type": "string",
349
- "required": true
350
- },
351
- "attributes": {
352
- "type": "object",
353
- "required": true
354
- }
355
- },
356
- "output": "profile"
357
- },
358
- "profile.upsert": {
359
- "kind": "write",
360
- "method": "createOrUpdateProfile",
361
- "input": {
362
- "attributes": {
363
- "type": "object",
364
- "required": true
365
- }
366
- },
367
- "output": "profile"
368
- },
369
- "profile.lists": {
370
- "kind": "read",
371
- "method": "getProfileLists",
372
- "input": {
373
- "id": {
374
- "type": "string",
375
- "required": true
376
- }
377
- },
378
- "output": "list[]"
379
- },
380
- "profile.subscribe": {
381
- "kind": "write",
382
- "method": "subscribeProfiles",
383
- "input": {
384
- "listId": {
385
- "type": "string",
386
- "required": true
387
- },
388
- "email": {
389
- "type": "string"
390
- },
391
- "phoneNumber": {
392
- "type": "string"
393
- },
394
- "channels": {
395
- "type": "array"
396
- }
397
- },
398
- "output": "void"
399
- },
400
- "profile.unsubscribe": {
401
- "kind": "write",
402
- "method": "unsubscribeProfiles",
403
- "input": {
404
- "email": {
405
- "type": "string",
406
- "required": true
407
- },
408
- "listId": {
409
- "type": "string"
410
- }
411
- },
412
- "output": "void"
413
- },
414
- "list.list": {
415
- "kind": "read",
416
- "method": "getLists",
417
- "input": {},
418
- "output": "list[]"
419
- },
420
- "list.addProfiles": {
421
- "kind": "write",
422
- "method": "addProfilesToList",
423
- "input": {
424
- "listId": {
425
- "type": "string",
426
- "required": true
427
- },
428
- "profileIds": {
429
- "type": "array",
430
- "required": true
431
- }
432
- },
433
- "output": "void"
434
- },
435
- "event.create": {
436
- "kind": "write",
437
- "method": "createEvent",
438
- "input": {
439
- "metric": {
440
- "type": "string",
441
- "required": true
442
- },
443
- "profile": {
444
- "type": "object",
445
- "required": true
446
- },
447
- "properties": {
448
- "type": "object"
449
- },
450
- "value": {
451
- "type": "number"
452
- },
453
- "time": {
454
- "type": "string"
455
- },
456
- "uniqueId": {
457
- "type": "string"
458
- }
459
- },
460
- "output": "void"
461
- },
462
- "webhook.create": {
463
- "kind": "subscribe",
464
- "method": "createWebhook",
465
- "input": {
466
- "name": {
467
- "type": "string",
468
- "required": true
469
- },
470
- "endpointUrl": {
471
- "type": "string",
472
- "required": true
473
- },
474
- "topics": {
475
- "type": "array",
476
- "required": true
477
- },
478
- "secretKey": {
479
- "type": "string"
480
- }
481
- },
482
- "output": "webhook"
483
- },
484
- "webhook.delete": {
485
- "kind": "delete",
486
- "method": "deleteWebhook",
487
- "input": {
488
- "id": {
489
- "type": "string",
490
- "required": true
491
- }
492
- },
493
- "output": "void"
494
- }
495
- },
496
- "options": {
497
- "list": {
498
- "capability": "list.list",
499
- "label": "{{item.attributes.name}}",
500
- "value": "$.item.id"
501
- }
502
- }
503
- }