@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,314 +0,0 @@
1
- {
2
- "$schema": "https://friggframework.org/schemas/capability-manifest/v0.1.json",
3
- "module": "docusign",
4
- "label": "DocuSign eSignature",
5
- "package": "@friggframework/api-module-docusign",
6
- "version": "1.2.0",
7
- "auth": "oauth2",
8
- "objects": {
9
- "envelope": {
10
- "label": "Envelope",
11
- "fields": [
12
- {
13
- "name": "envelopeId",
14
- "type": "id",
15
- "readOnly": true
16
- },
17
- {
18
- "name": "status",
19
- "type": "enum",
20
- "tag": "agreement.status",
21
- "values": [
22
- "created",
23
- "sent",
24
- "delivered",
25
- "signed",
26
- "completed",
27
- "declined",
28
- "voided"
29
- ],
30
- "readOnly": true
31
- },
32
- {
33
- "name": "emailSubject",
34
- "type": "string",
35
- "tag": "agreement.title"
36
- },
37
- {
38
- "name": "sentDateTime",
39
- "type": "datetime",
40
- "readOnly": true
41
- },
42
- {
43
- "name": "completedDateTime",
44
- "type": "datetime",
45
- "tag": "agreement.completedAt",
46
- "readOnly": true
47
- },
48
- {
49
- "name": "declinedDateTime",
50
- "type": "datetime",
51
- "readOnly": true
52
- },
53
- {
54
- "name": "sender.email",
55
- "type": "email",
56
- "tag": "record.owner",
57
- "readOnly": true
58
- },
59
- {
60
- "name": "recipients.signers",
61
- "type": "json",
62
- "tag": "agreement.signers"
63
- },
64
- {
65
- "name": "customFields.textCustomFields",
66
- "type": "json"
67
- }
68
- ]
69
- }
70
- },
71
- "events": {
72
- "envelope.completed": {
73
- "delivery": "webhook",
74
- "object": "envelope",
75
- "subscribe": "connect.create",
76
- "description": "DocuSign Connect (JSON SIM) event envelope-completed.",
77
- "payload": {
78
- "event": "envelope-completed",
79
- "apiVersion": "v2.1",
80
- "uri": "/restapi/v2.1/accounts/9c1b2f3e/envelopes/7d2e8f14-3a6b-4c91-9e20-5b1f7c8a2d63",
81
- "retryCount": 0,
82
- "configurationId": 10457,
83
- "generatedDateTime": "2026-10-20T16:00:02.112Z",
84
- "data": {
85
- "accountId": "9c1b2f3e-1a2b-4c3d-8e9f-0a1b2c3d4e5f",
86
- "userId": "4b2a1e8c-0a1b-4c55-9d1b-6f4b2a1e8c33",
87
- "envelopeId": "7d2e8f14-3a6b-4c91-9e20-5b1f7c8a2d63",
88
- "envelopeSummary": {
89
- "envelopeId": "7d2e8f14-3a6b-4c91-9e20-5b1f7c8a2d63",
90
- "status": "completed",
91
- "emailSubject": "Please sign: Acme Corp MSA and Work Order 3",
92
- "sentDateTime": "2026-10-19T14:00:00.000Z",
93
- "sender": {
94
- "userName": "Alex Morgan",
95
- "email": "alex@acme.example"
96
- },
97
- "recipients": {
98
- "signers": [
99
- {
100
- "recipientId": "1",
101
- "name": "Priya Natarajan",
102
- "email": "priya@acme.example",
103
- "status": "completed",
104
- "routingOrder": "1"
105
- }
106
- ]
107
- },
108
- "customFields": {
109
- "textCustomFields": [
110
- {
111
- "fieldId": "10498",
112
- "name": "SalesforceOpportunityId",
113
- "value": "0068c00000ABCDeAAP",
114
- "show": "false"
115
- }
116
- ]
117
- },
118
- "completedDateTime": "2026-10-20T15:59:40.000Z"
119
- }
120
- }
121
- },
122
- "record": "data.envelopeSummary",
123
- "match": "envelope-completed"
124
- },
125
- "envelope.declined": {
126
- "delivery": "webhook",
127
- "object": "envelope",
128
- "subscribe": "connect.create",
129
- "payload": {
130
- "event": "envelope-declined",
131
- "apiVersion": "v2.1",
132
- "uri": "/restapi/v2.1/accounts/9c1b2f3e/envelopes/7d2e8f14-3a6b-4c91-9e20-5b1f7c8a2d63",
133
- "retryCount": 0,
134
- "configurationId": 10457,
135
- "generatedDateTime": "2026-10-20T16:00:02.112Z",
136
- "data": {
137
- "accountId": "9c1b2f3e-1a2b-4c3d-8e9f-0a1b2c3d4e5f",
138
- "userId": "4b2a1e8c-0a1b-4c55-9d1b-6f4b2a1e8c33",
139
- "envelopeId": "7d2e8f14-3a6b-4c91-9e20-5b1f7c8a2d63",
140
- "envelopeSummary": {
141
- "envelopeId": "7d2e8f14-3a6b-4c91-9e20-5b1f7c8a2d63",
142
- "status": "declined",
143
- "emailSubject": "Please sign: Acme Corp MSA and Work Order 3",
144
- "sentDateTime": "2026-10-19T14:00:00.000Z",
145
- "sender": {
146
- "userName": "Alex Morgan",
147
- "email": "alex@acme.example"
148
- },
149
- "recipients": {
150
- "signers": [
151
- {
152
- "recipientId": "1",
153
- "name": "Priya Natarajan",
154
- "email": "priya@acme.example",
155
- "status": "declined",
156
- "declinedReason": "Legal needs to redline section 7 first."
157
- }
158
- ]
159
- },
160
- "customFields": {
161
- "textCustomFields": [
162
- {
163
- "fieldId": "10498",
164
- "name": "SalesforceOpportunityId",
165
- "value": "0068c00000ABCDeAAP",
166
- "show": "false"
167
- }
168
- ]
169
- },
170
- "declinedDateTime": "2026-10-20T13:12:00.000Z"
171
- }
172
- }
173
- },
174
- "record": "data.envelopeSummary",
175
- "match": "envelope-declined"
176
- },
177
- "envelope.sent": {
178
- "delivery": "webhook",
179
- "object": "envelope",
180
- "subscribe": "connect.create",
181
- "payload": {
182
- "event": "envelope-sent",
183
- "apiVersion": "v2.1",
184
- "uri": "/restapi/v2.1/accounts/9c1b2f3e/envelopes/7d2e8f14-3a6b-4c91-9e20-5b1f7c8a2d63",
185
- "retryCount": 0,
186
- "configurationId": 10457,
187
- "generatedDateTime": "2026-10-20T16:00:02.112Z",
188
- "data": {
189
- "accountId": "9c1b2f3e-1a2b-4c3d-8e9f-0a1b2c3d4e5f",
190
- "userId": "4b2a1e8c-0a1b-4c55-9d1b-6f4b2a1e8c33",
191
- "envelopeId": "7d2e8f14-3a6b-4c91-9e20-5b1f7c8a2d63",
192
- "envelopeSummary": {
193
- "envelopeId": "7d2e8f14-3a6b-4c91-9e20-5b1f7c8a2d63",
194
- "status": "sent",
195
- "emailSubject": "Please sign: Acme Corp MSA and Work Order 3",
196
- "sentDateTime": "2026-10-19T14:00:00.000Z",
197
- "sender": {
198
- "userName": "Alex Morgan",
199
- "email": "alex@acme.example"
200
- },
201
- "recipients": {
202
- "signers": [
203
- {
204
- "recipientId": "1",
205
- "name": "Priya Natarajan",
206
- "email": "priya@acme.example",
207
- "status": "sent",
208
- "routingOrder": "1"
209
- }
210
- ]
211
- },
212
- "customFields": {
213
- "textCustomFields": [
214
- {
215
- "fieldId": "10498",
216
- "name": "SalesforceOpportunityId",
217
- "value": "0068c00000ABCDeAAP",
218
- "show": "false"
219
- }
220
- ]
221
- }
222
- }
223
- }
224
- },
225
- "record": "data.envelopeSummary",
226
- "match": "envelope-sent"
227
- }
228
- },
229
- "webhook": {
230
- "scope": "installation",
231
- "topic": "{{body.event}}",
232
- "eventId": "{{body.data.envelopeId}}:{{body.event}}:{{body.generatedDateTime}}",
233
- "verify": "verifyWebhookSignature"
234
- },
235
- "capabilities": {
236
- "envelope.get": {
237
- "kind": "read",
238
- "method": "getEnvelope",
239
- "input": {
240
- "envelopeId": {
241
- "type": "string",
242
- "required": true
243
- },
244
- "include": {
245
- "type": "string"
246
- }
247
- },
248
- "output": "envelope"
249
- },
250
- "envelope.list": {
251
- "kind": "read",
252
- "method": "listStatusChanges",
253
- "input": {
254
- "from_date": {
255
- "type": "string"
256
- },
257
- "status": {
258
- "type": "string"
259
- },
260
- "custom_field": {
261
- "type": "string"
262
- },
263
- "count": {
264
- "type": "number"
265
- }
266
- },
267
- "output": "envelope[]"
268
- },
269
- "document.combined": {
270
- "kind": "read",
271
- "method": "getCombinedDocument",
272
- "input": {
273
- "envelopeId": {
274
- "type": "string",
275
- "required": true
276
- },
277
- "certificate": {
278
- "type": "boolean"
279
- }
280
- },
281
- "output": "{ base64: string, contentType: string }"
282
- },
283
- "connect.create": {
284
- "kind": "subscribe",
285
- "method": "createConnectConfiguration",
286
- "input": {
287
- "name": {
288
- "type": "string",
289
- "required": true
290
- },
291
- "urlToPublishTo": {
292
- "type": "string",
293
- "required": true
294
- },
295
- "events": {
296
- "type": "array",
297
- "required": true
298
- }
299
- },
300
- "output": "connectConfiguration"
301
- },
302
- "connect.delete": {
303
- "kind": "delete",
304
- "method": "deleteConnectConfiguration",
305
- "input": {
306
- "connectId": {
307
- "type": "string",
308
- "required": true
309
- }
310
- },
311
- "output": "void"
312
- }
313
- }
314
- }
@@ -1,238 +0,0 @@
1
- {
2
- "$schema": "https://friggframework.org/schemas/capability-manifest/v0.1.json",
3
- "module": "fathom",
4
- "label": "Fathom",
5
- "package": "@friggframework/api-module-fathom",
6
- "version": "0.4.0",
7
- "auth": "api_key",
8
- "objects": {
9
- "meeting": {
10
- "label": "Meeting recording",
11
- "fields": [
12
- {
13
- "name": "recording_id",
14
- "type": "id",
15
- "readOnly": true
16
- },
17
- {
18
- "name": "title",
19
- "type": "string",
20
- "tag": "meeting.title"
21
- },
22
- {
23
- "name": "url",
24
- "type": "string",
25
- "readOnly": true
26
- },
27
- {
28
- "name": "share_url",
29
- "type": "string",
30
- "tag": "meeting.recordingUrl",
31
- "readOnly": true
32
- },
33
- {
34
- "name": "scheduled_start_time",
35
- "type": "datetime",
36
- "tag": "meeting.scheduledStart"
37
- },
38
- {
39
- "name": "recording_start_time",
40
- "type": "datetime",
41
- "tag": "meeting.start"
42
- },
43
- {
44
- "name": "recording_end_time",
45
- "type": "datetime",
46
- "tag": "meeting.end"
47
- },
48
- {
49
- "name": "recorded_by.email",
50
- "type": "email",
51
- "tag": "record.owner"
52
- },
53
- {
54
- "name": "calendar_invitees",
55
- "type": "json",
56
- "tag": "meeting.attendees"
57
- },
58
- {
59
- "name": "default_summary.markdown_formatted",
60
- "type": "text",
61
- "tag": "meeting.summary"
62
- },
63
- {
64
- "name": "action_items",
65
- "type": "json",
66
- "tag": "meeting.actionItems"
67
- },
68
- {
69
- "name": "transcript_language",
70
- "type": "string"
71
- }
72
- ]
73
- }
74
- },
75
- "events": {
76
- "meeting.ready": {
77
- "delivery": "webhook",
78
- "object": "meeting",
79
- "subscribe": "webhook.create",
80
- "description": "Fired when a recording's summary, action items (and transcript, if asked for) are ready. The payload is the meeting.",
81
- "payload": {
82
- "recording_id": 123456789,
83
- "title": "Acme / Initech renewal review",
84
- "meeting_title": "Acme renewal",
85
- "url": "https://fathom.video/calls/123456789",
86
- "share_url": "https://fathom.video/share/zXv8m2KqQhJt",
87
- "created_at": "2026-10-20T15:47:10Z",
88
- "scheduled_start_time": "2026-10-20T15:00:00Z",
89
- "recording_start_time": "2026-10-20T15:01:12Z",
90
- "recording_end_time": "2026-10-20T15:46:30Z",
91
- "transcript_language": "en",
92
- "recorded_by": {
93
- "name": "Alex Morgan",
94
- "email": "alex@acme.example",
95
- "team": "Sales"
96
- },
97
- "calendar_invitees": [
98
- {
99
- "name": "Alex Morgan",
100
- "email": "alex@acme.example",
101
- "is_external": false
102
- },
103
- {
104
- "name": "Priya Natarajan",
105
- "email": "priya@acme.example",
106
- "email_domain": "acme.example",
107
- "is_external": true
108
- }
109
- ],
110
- "default_summary": {
111
- "template_name": "general",
112
- "markdown_formatted": "## Summary\nAcme wants to renew at the Medium tier and add a support block.\n\n## Next steps\n- Send revised order form"
113
- },
114
- "action_items": [
115
- {
116
- "description": "Send revised order form with the support block",
117
- "user_generated": false,
118
- "completed": false,
119
- "recording_timestamp": "00:31:05",
120
- "recording_playback_url": "https://fathom.video/calls/123456789?timestamp=1865",
121
- "assignee": {
122
- "name": "Alex Morgan",
123
- "email": "alex@acme.example"
124
- }
125
- },
126
- {
127
- "description": "Confirm procurement contact",
128
- "user_generated": false,
129
- "completed": false,
130
- "recording_timestamp": "00:38:40",
131
- "assignee": {
132
- "name": "Priya Natarajan",
133
- "email": "priya@acme.example"
134
- }
135
- }
136
- ]
137
- },
138
- "idPath": "recording_id"
139
- }
140
- },
141
- "webhook": {
142
- "scope": "installation",
143
- "topic": "meeting.ready",
144
- "eventId": "{{body.recording_id}}",
145
- "verify": "verifyWebhookSignature",
146
- "note": "Standard Webhooks: webhook-id, webhook-timestamp, webhook-signature (v1), 300 s. Implemented in api-module-library 659b90d; needs the module release that includes it."
147
- },
148
- "capabilities": {
149
- "meeting.list": {
150
- "kind": "read",
151
- "method": "listMeetings",
152
- "input": {
153
- "created_after": {
154
- "type": "string"
155
- },
156
- "calendar_invitees_domains": {
157
- "type": "array"
158
- },
159
- "include_summary": {
160
- "type": "boolean"
161
- },
162
- "include_action_items": {
163
- "type": "boolean"
164
- },
165
- "cursor": {
166
- "type": "string"
167
- }
168
- },
169
- "output": "page<meeting>"
170
- },
171
- "meeting.summary": {
172
- "kind": "read",
173
- "method": "getSummary",
174
- "input": {
175
- "recordingId": {
176
- "type": "string",
177
- "required": true
178
- }
179
- },
180
- "output": "summary",
181
- "args": [
182
- "recordingId"
183
- ]
184
- },
185
- "meeting.transcript": {
186
- "kind": "read",
187
- "method": "getTranscript",
188
- "input": {
189
- "recordingId": {
190
- "type": "string",
191
- "required": true
192
- }
193
- },
194
- "output": "transcript",
195
- "args": [
196
- "recordingId"
197
- ]
198
- },
199
- "webhook.create": {
200
- "kind": "subscribe",
201
- "method": "createWebhook",
202
- "input": {
203
- "destination_url": {
204
- "type": "string",
205
- "required": true
206
- },
207
- "triggered_for": {
208
- "type": "array",
209
- "required": true
210
- },
211
- "include_summary": {
212
- "type": "boolean"
213
- },
214
- "include_action_items": {
215
- "type": "boolean"
216
- },
217
- "include_transcript": {
218
- "type": "boolean"
219
- }
220
- },
221
- "output": "webhook"
222
- },
223
- "webhook.delete": {
224
- "kind": "delete",
225
- "method": "deleteWebhook",
226
- "input": {
227
- "id": {
228
- "type": "string",
229
- "required": true
230
- }
231
- },
232
- "output": "void",
233
- "args": [
234
- "id"
235
- ]
236
- }
237
- }
238
- }