--- title: "updateIntegrationV2" method: PUT path: "/v2/integrations/{integrationId}" tags: ["integrations"] --- # updateIntegrationV2 `PUT /v2/integrations/{integrationId}` Update an existing integration with embedded use cases. The integration must already exist. Use cases are updated declaratively: - Use cases in the request with matching IDs are updated - Use cases in the request without matching IDs are created - Existing use cases not in the request are deleted ## Path parameters - `integrationId` string, uuid, required ## Request body - UpsertIntegrationWithUseCasesRequest — Request to create or update an integration with embedded use cases (upsert). This is a declarative operation - the request represents the desired state. - `name` string, required — Integration name - `description` string — Optional description of the integration - `access_token_ids` string[] — List of access token IDs associated with this integration - `app_ids` string[] — List of app IDs associated with this integration - `environment_config` EnvironmentFieldConfig[] — Configuration defining environment variables needed by this integration. Values are stored in the Environments API. - `key` string, required — Environment variable key, used to look up the value in the Environments API. - `label` string, required — Display label for the field in the UI - `type` 'String' | 'SecretString', required — Whether the value is a plain string or an encrypted secret - `description` string — Help text shown below the field - `required` boolean — Whether this field must be filled before the integration can be used - `order` integer — Sort order for display and drag-to-reorder - `settings` IntegrationSettings — Settings for the integration - `autoRefresh` AutoRefreshSettings — Auto-refresh settings for keeping integration data fresh - `enabled` boolean — Whether auto-refresh is enabled - `freshnessThresholdMinutes` integer — Maximum age (in minutes) of data before it is considered stale and eligible for refresh - `notifications` IntegrationNotificationConfig — Integration monitoring notification configuration. Rides Integration.settings.notifications (camelCase) and surfaces on both v1 and v2 GET/PUT. Unknown keys are stripped server-side to stay forward-compatible with deferred (V2) rule types. - `enabled` boolean, required — Master switch for this integration's notifications. - `recipients` NotificationRecipient[], required — epilot user ids notified for this integration. Same-org membership and per-user notification preferences are enforced at send time (Phases 3–5), not at config-write time. - `user_id` string, required — epilot user id. Same-org membership is enforced at send time (Phases 3–5), which re-validates each recipient against the integration's org before fanning out — it is not enforced at config-write time. - `defaultChannels` NotificationChannelSet, required — Delivery channel toggles. New channels added in svc-notification-api inherit here. - `email` boolean, required - `in_app` boolean, required - `monitoredUseCases` string[] — Integration-level use-case include-filter; absent/empty means all use cases. - `monitoredCodes` string[] — Integration-level code scope; absent/empty resolves to ['_error_']. Accepts concrete monitoring error codes or group sentinels (_error_, _warning_, _success_, _info_, _any_, _parent_). - `rules` NotificationRule[], required — Enabled triggers and their params. A type MAY repeat; capped at 20 rules (enforced at the write boundary). - `id` string — Stable AlertState + baseline key. Optional on write — the server mints a ULID when omitted; a supplied id is preserved verbatim. - `name` string — Optional human label disambiguating two rules of the same type. - `type` 'critical_error' | 'error_threshold' | 'warning_threshold' | 'success_rate_drop' | 'recovery' | 'silence', required — Rule trigger type. These are the only supported types; each is produced by a real alerter. - `enabled` boolean, required - `channels` NotificationChannelSet — Delivery channel toggles. New channels added in svc-notification-api inherit here. - `email` boolean, required - `in_app` boolean, required - `codes` string[] — Per-rule code scope. Event-matching rules default to ['_parent_']; silence defaults to ['_any_']. success_rate_drop and recovery take no codes. - `threshold` union — Count or percentage; 'auto' selects anomaly-baseline mode. - number - 'auto' - `sensitivity` 'low' | 'medium' | 'high' — Band width for 'auto' mode. - `fallbackThreshold` number — Static value used while the 'auto' baseline is immature (cold start). - `window` string — Evaluation window, e.g. '15m', '1h', '24h'. - `minSampleSize` integer — success_rate_drop minimum sample size guard. - `quietPeriod` string — silence quiet period, e.g. '12h'. - `digest` NotificationDigestConfig, required — Digest schedule and content configuration. - `enabled` boolean, required - `frequency` 'daily' | 'weekly', required - `dayOfWeek` 0 | 1 | 2 | 3 | 4 | 5 | 6 — Weekly only. 0 = Sunday … 6 = Saturday. - `timeOfDay` string, required — HH:mm - `timezone` string, required — IANA timezone, e.g. 'Europe/Berlin'. - `channels` NotificationChannelSet, required — Delivery channel toggles. New channels added in svc-notification-api inherit here. - `email` boolean, required - `in_app` boolean, required - `includeHealthy` boolean, required — List all integrations vs. only ones with issues. - `skipIfEmpty` boolean, required — Suppress the digest when nothing happened. - `muteUntil` string, date-time, nullable — ISO instant; snooze all non-digest alerts until this time. `null` means not muted. - `integration_type` 'erp' | 'connector' — Type of integration. "erp" is the ERP integration with inbound/outbound use cases. "connector" is for complex proxy integrations with external APIs. - `connector_config` ConnectorConfig — Shared configuration for connector-type integrations - `base_url` string — Base URL for the partner API - `auth` ManagedCallAuth — Authentication configuration for managed call requests - `type` 'oauth2_client_credentials' | 'api_key' | 'bearer' — Authentication type - `token_url` string — OAuth2 token URL. Can be plain text or {{env.key}} reference. - `client_id` string — OAuth2 client ID. Can be plain text or {{env.key}} reference. - `client_secret` string — OAuth2 client secret. Must be an {{env.key}} reference (secret). - `scope` string — OAuth2 scope - `audience` string — OAuth2 audience parameter (e.g. for Auth0, Azure AD). Can be plain text or {{env.key}} reference. - `resource` string — OAuth2 resource parameter (e.g. for Azure AD). Can be plain text or {{env.key}} reference. - `body_params` object — Additional key-value pairs for the OAuth2 token request body. Values can be {{env.key}} references. - `headers` object — Additional headers for the OAuth2 token request. Values can be {{env.key}} references. - `query_params` object — Additional query parameters for the OAuth2 token URL. Values can be {{env.key}} references. - `api_key_header` string — Header name for API key auth (default X-API-Key) - `api_key` string — API key value. Must be an {{env.key}} reference (secret). - `token` string — Bearer token value. Must be an {{env.key}} reference (secret). - `types_versions` object[] — History of generated type package versions - `version` string, required - `package_name` string, required - `generated_at` string, date-time, required - `generated_by` string, required - `status` 'active' | 'deprecated', required - `latest_types_version` string — Latest active types package version - `latest_types_package_name` string — Latest active types package name - `protected` boolean — If true, integration is displayed in read-only mode in the UI to discourage changes - `_manifest` string[] — The manifest IDs associated with this integration - `use_cases` EmbeddedUseCaseRequest[] — Full list of use cases (declarative). This replaces ALL existing use cases. - Use cases with an `id` field matching an existing use case will be updated - Use cases without an `id` or with a non-matching `id` will be created - Existing use cases not in this list will be deleted - union - EmbeddedInboundUseCaseRequest - `id` string, uuid — Optional use case ID for update matching. - If provided and matches an existing use case, that use case is updated - If provided but no match, a new use case with this ID is created - If omitted, a new use case with auto-generated ID is created - `name` string, required — Use case name - `slug` string — URL-safe identifier for the use case. Optional on this upsert/sync endpoint — when omitted, the server derives one from the name and ensures uniqueness within the integration. Immutable after creation. - `enabled` boolean, required — Whether the use case is enabled - `change_description` string — Optional description of this change (like a commit message) - `type` 'inbound', required — Use case type - `configuration` InboundIntegrationEventConfiguration — Configuration for inbound use cases (ERP to epilot) - `entities` IntegrationEntity[] — Array of entity configurations for this event - `entity_schema` string, required — Target entity schema (e.g., 'contact', 'contract') - `unique_ids` string[], required — Array of attribute names that uniquely identify this entity. The _type hint for repeatable fields (e.g., email, phone) should be specified on the corresponding field definition in the fields array. - `jsonataExpression` string — Optional JSONata expression to pre-process the event data before field mapping - `enabled` union — Controls whether this entity mapping should be processed. Can be a boolean or a JSONata expression (string) that evaluates to a boolean. - … - `mode` 'upsert' | 'delete' | 'purge' | 'upsert-prune-scope-purge' | 'upsert-prune-scope-delete' — Operation mode for entity mapping: - 'upsert': Create or update the entity (default) - 'delete': Soft delete the entity (marks as deleted) - 'purge': Hard delete the entity (permanent removal) - 'upsert-prune-scope-purge': Upsert entities from array, then purge entities in scope that weren't upserted - 'upsert-prune-scope-delete': Upsert entities from array, then soft delete entities in scope that weren't upserted - `scope` PruneScopeConfig — Scope configuration for upsert-prune-scope modes. Defines how to find entities that should be pruned if not in the upsert payload. The scope is resolved against the original event payload (not individual array items). - … - `fields` IntegrationEntityField[], required — Field mapping definitions - … - `meter_readings` IntegrationMeterReading[] — Array of meter reading configurations for this event - `jsonataExpression` string — Optional JSONata expression to extract meter reading items from the event data. If not provided, the entire payload is used as the reading data. Useful when you need to extract an array of readings from a nested structure (e.g., "$.readings"). - `reading_matching` 'external_id' | 'strict-date' — Strategy for matching incoming readings against existing readings. - 'external_id': Match readings by external_id attribute (default behavior) - 'strict-date': Match by meter_id + counter_id + direction + date (German timezone). Useful when readings originate from ECP and are echoed back by the ERP with truncated timestamps. - `mode` 'upsert' | 'delete' | 'upsert-prune-scope' — Operation mode for meter reading mapping: - 'upsert': Create or update meter readings (default) - 'delete': Delete the meter reading - 'upsert-prune-scope': Upsert readings from array, then delete all other readings for the same meter+counter that weren't upserted - `scope` MeterReadingPruneScopeConfig — Scope configuration for meter reading upsert-prune-scope mode. The scope is all readings for the same meter + counter. - … - `meter` MeterUniqueIdsConfig, required - … - `meter_counter` MeterUniqueIdsConfig - … - `fields` IntegrationEntityField[], required — Field mapping definitions for meter reading attributes - … - EmbeddedOutboundUseCaseRequest - `id` string, uuid — Optional use case ID for update matching. - If provided and matches an existing use case, that use case is updated - If provided but no match, a new use case with this ID is created - If omitted, a new use case with auto-generated ID is created - `name` string, required — Use case name - `slug` string — URL-safe identifier for the use case. Optional on this upsert/sync endpoint — when omitted, the server derives one from the name and ensures uniqueness within the integration. Immutable after creation. - `enabled` boolean, required — Whether the use case is enabled - `change_description` string — Optional description of this change (like a commit message) - `type` 'outbound', required — Use case type - `configuration` OutboundIntegrationEventConfiguration — Configuration for outbound use cases. Defines the event that triggers the flow and the webhook mappings. - `event_catalog_event` string, required — The Event Catalog event name that triggers this outbound flow - `mappings` OutboundMapping[], required — List of mappings that transform and deliver the event - `id` string, uuid — Unique identifier for this mapping - `name` string, required — Human-readable name for this mapping - `jsonata_expression` string — JSONata expression to transform the event payload. Required for webhook delivery; ignored for poll delivery. - `enabled` boolean, required — Whether this mapping is active - `delivery` union, required — Configuration for how the event should be delivered. webhook = push delivery via svc-webhooks (JSONata-transformed payload); poll = pull-based queue delivery where the consumer fetches items via the poll API (raw event payload) - … - `created_at` string, date-time — Timestamp when the mapping was created - `updated_at` string, date-time — Timestamp when the mapping was last updated - EmbeddedFileProxyUseCaseRequest - `id` string, uuid — Optional use case ID for update matching. - If provided and matches an existing use case, that use case is updated - If provided but no match, a new use case with this ID is created - If omitted, a new use case with auto-generated ID is created - `name` string, required — Use case name - `slug` string — URL-safe identifier for the use case. Optional on this upsert/sync endpoint — when omitted, the server derives one from the name and ensures uniqueness within the integration. Immutable after creation. - `enabled` boolean, required — Whether the use case is enabled - `change_description` string — Optional description of this change (like a commit message) - `type` 'file_proxy', required — Use case type - `configuration` FileProxyUseCaseConfiguration — Configuration for file_proxy use cases. Defines how to authenticate and fetch files from external document systems. The file proxy download URL always requires `orgId`, `integrationId`, and either `useCaseSlug` (recommended) or `useCaseId` (legacy UUID) as query parameters. The `orgId` is included in the signed URL to establish organization context without requiring authentication. Additional use-case-specific parameters are declared in the `params` array. - `secure_proxy` FileProxySecureProxyAttachment - `use_case_slug` string, required — Slug of the secure_proxy use case in the same integration. - `auth` FileProxyAuth - `type` 'oauth2_client_credentials' | 'oauth2_password', required — Authentication type - `token_url` string, required — Handlebars template for the OAuth2 token endpoint URL - `client_id` string, required — Handlebars template for the OAuth2 client ID - `client_secret` string, required — Handlebars template for the OAuth2 client secret - `scope` string — Optional OAuth2 scope - `audience` string — Handlebars template for the OAuth2 audience parameter - `resource` string — Handlebars template for the OAuth2 resource parameter - `username` string — Handlebars template for the OAuth2 resource owner username. Required when type is oauth2_password. - `password` string — Handlebars template for the OAuth2 resource owner password. Required when type is oauth2_password. - `body_params` object — Additional key-value pairs to include in the token request body. Values support Handlebars templates. - `headers` object — Additional headers to include in the token request. Values support Handlebars templates. - `query_params` object — Additional query parameters to append to the token URL. Values support Handlebars templates. - `params` FileProxyParam[] — Additional use-case-specific parameters expected in the download URL query string (beyond the required orgId, integrationId, and useCaseSlug or useCaseId) - `name` string, required — Parameter name as it appears in the query string - `required` boolean, required — Whether this parameter is required - `description` string — Human-readable description of the parameter - `allowed_origins` string[] — Additional origins permitted to call /download for this use case (CORS, exact match). Portal origins are always allowed. - `steps` FileProxyStep[], required — Ordered list of HTTP steps to execute to retrieve the file - `url` string, required — Handlebars template for the request URL - `method` 'GET' | 'POST', required — HTTP method - `headers` object — Handlebars templates for request headers - `body` string — Handlebars template for the request body (POST only) - `response_type` 'json' | 'binary', required — Expected response type - `response` FileProxyResponseConfig, required - `body` string, required — JSONata expression to extract file content from step results - `encoding` 'base64' | 'binary', required — Encoding of the extracted body - `filename` string — JSONata expression to extract the filename - `content_type` string — JSONata expression to extract the content type - `prevent_indirect_serving` boolean — When `true`, this use case is served via the streaming endpoint: mapped file URLs are built as `/stream/download`, files of any size are streamed inline over HTTP response streaming, and buffered `/download` requests for oversize files are 307-redirected to `/stream`. Files never transit epilot's temporary S3 storage on the streaming path. Defaults to `false` (small files are served directly and large files are transparently served via a temporary S3 redirect). - EmbeddedManagedCallUseCaseRequest - `id` string, uuid — Optional use case ID for update matching. - If provided and matches an existing use case, that use case is updated - If provided but no match, a new use case with this ID is created - If omitted, a new use case with auto-generated ID is created - `name` string, required — Use case name - `slug` string — URL-safe identifier for the use case. Optional on this upsert/sync endpoint — when omitted, the server derives one from the name and ensures uniqueness within the integration. Immutable after creation. - `enabled` boolean, required — Whether the use case is enabled - `change_description` string — Optional description of this change (like a commit message) - `type` 'managed_call', required — Use case type for managed API calls - `configuration` ManagedCallOperationConfig — Configuration for managed_call use cases. Defines a single API operation with JSONata mapping. - `operation` ManagedCallOperation, required — HTTP operation configuration for managed calls - `method` 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE', required - `path` string, required — URL path template with {{variable}} interpolation - `headers` object — Custom HTTP headers for the request. Values support {{variable}} interpolation from the request payload and {{env.VAR}} references for environment variables. - `query_params` object — Query parameters for the request. Values support {{variable}} interpolation from the request payload. - `request_mapping` string — JSONata expression for outbound body transformation - `response_mapping` string — JSONata expression for inbound response transformation - `inbound_use_case_slug` string — Slug of the inbound use case to route responses to for async entity processing. When set, the managed call response is queued to the inbound pipeline and processed using the referenced inbound use case's mapping configuration. - EmbeddedSecureProxyUseCaseRequest - `id` string, uuid — Optional use case ID for update matching. - If provided and matches an existing use case, that use case is updated - If provided but no match, a new use case with this ID is created - If omitted, a new use case with auto-generated ID is created - `name` string, required — Use case name - `slug` string — URL-safe identifier for the use case. Optional on this upsert/sync endpoint — when omitted, the server derives one from the name and ensures uniqueness within the integration. Immutable after creation. - `enabled` boolean, required — Whether the use case is enabled - `change_description` string — Optional description of this change (like a commit message) - `type` 'secure_proxy', required — Use case type - `configuration` SecureProxyUseCaseConfiguration — Configuration for secure_proxy use cases. Defines how to route requests through a secure VPC. - `vpc_mode` 'static_ip' | 'secure_link', required — VPC routing mode. Read-only after creation. - static_ip: Routes through a VPC with static outbound IP (NAT Gateway) for IP-allowlisted external APIs. - secure_link: Routes through a VPN VPC for accessing private customer networks. - `allowed_domains` string[] — Domain whitelist for secure_link mode. Admin-only — can only be modified directly in DynamoDB via admin script. Supports exact match (e.g., "api.wemag.com") and wildcard prefix (e.g., "*.wemag.com"). - `allowed_ips` string[] — IP allowlist (CIDR notation) for secure_link mode. Admin-only — can only be modified directly in DynamoDB via admin script. Required for secure_link mode. All DNS-resolved IPs must match at least one range. Example: ["10.0.1.0/24", "192.168.1.0/24"] ## Response `200` Integration updated successfully with use cases - IntegrationWithUseCases — Integration with embedded use cases for atomic CRUD operations - `id` string, uuid, required — Unique identifier for the integration - `orgId` string, required — Organization ID - `created_at` string, date-time, required — ISO-8601 timestamp when the integration was created - `updated_at` string, date-time, required — ISO-8601 timestamp when the integration was last updated - `name` string, required — Integration name - `description` string — Optional description of the integration - `access_token_ids` string[] — List of access token IDs associated with this integration - `app_ids` string[] — List of app IDs associated with this integration - `environment_config` EnvironmentFieldConfig[] — Configuration defining environment variables needed by this integration. Values are stored in the Environments API. - `key` string, required — Environment variable key, used to look up the value in the Environments API. - `label` string, required — Display label for the field in the UI - `type` 'String' | 'SecretString', required — Whether the value is a plain string or an encrypted secret - `description` string — Help text shown below the field - `required` boolean — Whether this field must be filled before the integration can be used - `order` integer — Sort order for display and drag-to-reorder - `settings` IntegrationSettings — Settings for the integration - `autoRefresh` AutoRefreshSettings — Auto-refresh settings for keeping integration data fresh - `enabled` boolean — Whether auto-refresh is enabled - `freshnessThresholdMinutes` integer — Maximum age (in minutes) of data before it is considered stale and eligible for refresh - `notifications` IntegrationNotificationConfig — Integration monitoring notification configuration. Rides Integration.settings.notifications (camelCase) and surfaces on both v1 and v2 GET/PUT. Unknown keys are stripped server-side to stay forward-compatible with deferred (V2) rule types. - `enabled` boolean, required — Master switch for this integration's notifications. - `recipients` NotificationRecipient[], required — epilot user ids notified for this integration. Same-org membership and per-user notification preferences are enforced at send time (Phases 3–5), not at config-write time. - `user_id` string, required — epilot user id. Same-org membership is enforced at send time (Phases 3–5), which re-validates each recipient against the integration's org before fanning out — it is not enforced at config-write time. - `defaultChannels` NotificationChannelSet, required — Delivery channel toggles. New channels added in svc-notification-api inherit here. - `email` boolean, required - `in_app` boolean, required - `monitoredUseCases` string[] — Integration-level use-case include-filter; absent/empty means all use cases. - `monitoredCodes` string[] — Integration-level code scope; absent/empty resolves to ['_error_']. Accepts concrete monitoring error codes or group sentinels (_error_, _warning_, _success_, _info_, _any_, _parent_). - `rules` NotificationRule[], required — Enabled triggers and their params. A type MAY repeat; capped at 20 rules (enforced at the write boundary). - `id` string — Stable AlertState + baseline key. Optional on write — the server mints a ULID when omitted; a supplied id is preserved verbatim. - `name` string — Optional human label disambiguating two rules of the same type. - `type` 'critical_error' | 'error_threshold' | 'warning_threshold' | 'success_rate_drop' | 'recovery' | 'silence', required — Rule trigger type. These are the only supported types; each is produced by a real alerter. - `enabled` boolean, required - `channels` NotificationChannelSet — Delivery channel toggles. New channels added in svc-notification-api inherit here. - `email` boolean, required - `in_app` boolean, required - `codes` string[] — Per-rule code scope. Event-matching rules default to ['_parent_']; silence defaults to ['_any_']. success_rate_drop and recovery take no codes. - `threshold` union — Count or percentage; 'auto' selects anomaly-baseline mode. - number - 'auto' - `sensitivity` 'low' | 'medium' | 'high' — Band width for 'auto' mode. - `fallbackThreshold` number — Static value used while the 'auto' baseline is immature (cold start). - `window` string — Evaluation window, e.g. '15m', '1h', '24h'. - `minSampleSize` integer — success_rate_drop minimum sample size guard. - `quietPeriod` string — silence quiet period, e.g. '12h'. - `digest` NotificationDigestConfig, required — Digest schedule and content configuration. - `enabled` boolean, required - `frequency` 'daily' | 'weekly', required - `dayOfWeek` 0 | 1 | 2 | 3 | 4 | 5 | 6 — Weekly only. 0 = Sunday … 6 = Saturday. - `timeOfDay` string, required — HH:mm - `timezone` string, required — IANA timezone, e.g. 'Europe/Berlin'. - `channels` NotificationChannelSet, required — Delivery channel toggles. New channels added in svc-notification-api inherit here. - `email` boolean, required - `in_app` boolean, required - `includeHealthy` boolean, required — List all integrations vs. only ones with issues. - `skipIfEmpty` boolean, required — Suppress the digest when nothing happened. - `muteUntil` string, date-time, nullable — ISO instant; snooze all non-digest alerts until this time. `null` means not muted. - `integration_type` 'erp' | 'connector' — Type of integration. "erp" is the ERP integration with inbound/outbound use cases. "connector" is for complex proxy integrations with external APIs. - `connector_config` ConnectorConfig — Shared configuration for connector-type integrations - `base_url` string — Base URL for the partner API - `auth` ManagedCallAuth — Authentication configuration for managed call requests - `type` 'oauth2_client_credentials' | 'api_key' | 'bearer' — Authentication type - `token_url` string — OAuth2 token URL. Can be plain text or {{env.key}} reference. - `client_id` string — OAuth2 client ID. Can be plain text or {{env.key}} reference. - `client_secret` string — OAuth2 client secret. Must be an {{env.key}} reference (secret). - `scope` string — OAuth2 scope - `audience` string — OAuth2 audience parameter (e.g. for Auth0, Azure AD). Can be plain text or {{env.key}} reference. - `resource` string — OAuth2 resource parameter (e.g. for Azure AD). Can be plain text or {{env.key}} reference. - `body_params` object — Additional key-value pairs for the OAuth2 token request body. Values can be {{env.key}} references. - `headers` object — Additional headers for the OAuth2 token request. Values can be {{env.key}} references. - `query_params` object — Additional query parameters for the OAuth2 token URL. Values can be {{env.key}} references. - `api_key_header` string — Header name for API key auth (default X-API-Key) - `api_key` string — API key value. Must be an {{env.key}} reference (secret). - `token` string — Bearer token value. Must be an {{env.key}} reference (secret). - `types_versions` object[] — History of generated type package versions - `version` string, required - `package_name` string, required - `generated_at` string, date-time, required - `generated_by` string, required - `status` 'active' | 'deprecated', required - `latest_types_version` string — Latest active types package version - `latest_types_package_name` string — Latest active types package name - `protected` boolean — If true, integration is displayed in read-only mode in the UI to discourage changes - `_manifest` string[] — The manifest IDs associated with this integration - `use_cases` UseCase[], required — All use cases belonging to this integration - union - InboundUseCase - `id` string, uuid, required — Unique identifier for the use case - `integrationId` string, uuid, required — Parent integration ID - `name` string, required — Use case name - `slug` string — URL-safe identifier for the use case. Recommended for portable cross-environment referencing. Unique per integration. Immutable after creation. Lowercase alphanumeric, hyphens, and underscores only. - `type` 'inbound', required — Use case type - `enabled` boolean, required - `change_description` string — Description of the last change made to this use case - `created_at` string, date-time, required — ISO-8601 timestamp when the use case was created - `updated_at` string, date-time, required — ISO-8601 timestamp when the use case was last updated - `configuration` InboundIntegrationEventConfiguration — Configuration for inbound use cases (ERP to epilot) - `entities` IntegrationEntity[] — Array of entity configurations for this event - `entity_schema` string, required — Target entity schema (e.g., 'contact', 'contract') - `unique_ids` string[], required — Array of attribute names that uniquely identify this entity. The _type hint for repeatable fields (e.g., email, phone) should be specified on the corresponding field definition in the fields array. - `jsonataExpression` string — Optional JSONata expression to pre-process the event data before field mapping - `enabled` union — Controls whether this entity mapping should be processed. Can be a boolean or a JSONata expression (string) that evaluates to a boolean. - … - `mode` 'upsert' | 'delete' | 'purge' | 'upsert-prune-scope-purge' | 'upsert-prune-scope-delete' — Operation mode for entity mapping: - 'upsert': Create or update the entity (default) - 'delete': Soft delete the entity (marks as deleted) - 'purge': Hard delete the entity (permanent removal) - 'upsert-prune-scope-purge': Upsert entities from array, then purge entities in scope that weren't upserted - 'upsert-prune-scope-delete': Upsert entities from array, then soft delete entities in scope that weren't upserted - `scope` PruneScopeConfig — Scope configuration for upsert-prune-scope modes. Defines how to find entities that should be pruned if not in the upsert payload. The scope is resolved against the original event payload (not individual array items). - … - `fields` IntegrationEntityField[], required — Field mapping definitions - … - `meter_readings` IntegrationMeterReading[] — Array of meter reading configurations for this event - `jsonataExpression` string — Optional JSONata expression to extract meter reading items from the event data. If not provided, the entire payload is used as the reading data. Useful when you need to extract an array of readings from a nested structure (e.g., "$.readings"). - `reading_matching` 'external_id' | 'strict-date' — Strategy for matching incoming readings against existing readings. - 'external_id': Match readings by external_id attribute (default behavior) - 'strict-date': Match by meter_id + counter_id + direction + date (German timezone). Useful when readings originate from ECP and are echoed back by the ERP with truncated timestamps. - `mode` 'upsert' | 'delete' | 'upsert-prune-scope' — Operation mode for meter reading mapping: - 'upsert': Create or update meter readings (default) - 'delete': Delete the meter reading - 'upsert-prune-scope': Upsert readings from array, then delete all other readings for the same meter+counter that weren't upserted - `scope` MeterReadingPruneScopeConfig — Scope configuration for meter reading upsert-prune-scope mode. The scope is all readings for the same meter + counter. - … - `meter` MeterUniqueIdsConfig, required - … - `meter_counter` MeterUniqueIdsConfig - … - `fields` IntegrationEntityField[], required — Field mapping definitions for meter reading attributes - … - OutboundUseCase - `id` string, uuid, required — Unique identifier for the use case - `integrationId` string, uuid, required — Parent integration ID - `name` string, required — Use case name - `slug` string — URL-safe identifier for the use case. Recommended for portable cross-environment referencing. Unique per integration. Immutable after creation. Lowercase alphanumeric, hyphens, and underscores only. - `type` 'outbound', required — Use case type - `enabled` boolean, required - `change_description` string — Description of the last change made to this use case - `created_at` string, date-time, required — ISO-8601 timestamp when the use case was created - `updated_at` string, date-time, required — ISO-8601 timestamp when the use case was last updated - `configuration` OutboundIntegrationEventConfiguration — Configuration for outbound use cases. Defines the event that triggers the flow and the webhook mappings. - `event_catalog_event` string, required — The Event Catalog event name that triggers this outbound flow - `mappings` OutboundMapping[], required — List of mappings that transform and deliver the event - `id` string, uuid — Unique identifier for this mapping - `name` string, required — Human-readable name for this mapping - `jsonata_expression` string — JSONata expression to transform the event payload. Required for webhook delivery; ignored for poll delivery. - `enabled` boolean, required — Whether this mapping is active - `delivery` union, required — Configuration for how the event should be delivered. webhook = push delivery via svc-webhooks (JSONata-transformed payload); poll = pull-based queue delivery where the consumer fetches items via the poll API (raw event payload) - … - `created_at` string, date-time — Timestamp when the mapping was created - `updated_at` string, date-time — Timestamp when the mapping was last updated - FileProxyUseCase - `id` string, uuid, required — Unique identifier for the use case - `integrationId` string, uuid, required — Parent integration ID - `name` string, required — Use case name - `slug` string — URL-safe identifier for the use case. Recommended for portable cross-environment referencing. Unique per integration. Immutable after creation. Lowercase alphanumeric, hyphens, and underscores only. - `type` 'file_proxy', required — Use case type - `enabled` boolean, required - `change_description` string — Description of the last change made to this use case - `created_at` string, date-time, required — ISO-8601 timestamp when the use case was created - `updated_at` string, date-time, required — ISO-8601 timestamp when the use case was last updated - `configuration` FileProxyUseCaseConfiguration — Configuration for file_proxy use cases. Defines how to authenticate and fetch files from external document systems. The file proxy download URL always requires `orgId`, `integrationId`, and either `useCaseSlug` (recommended) or `useCaseId` (legacy UUID) as query parameters. The `orgId` is included in the signed URL to establish organization context without requiring authentication. Additional use-case-specific parameters are declared in the `params` array. - `secure_proxy` FileProxySecureProxyAttachment - `use_case_slug` string, required — Slug of the secure_proxy use case in the same integration. - `auth` FileProxyAuth - `type` 'oauth2_client_credentials' | 'oauth2_password', required — Authentication type - `token_url` string, required — Handlebars template for the OAuth2 token endpoint URL - `client_id` string, required — Handlebars template for the OAuth2 client ID - `client_secret` string, required — Handlebars template for the OAuth2 client secret - `scope` string — Optional OAuth2 scope - `audience` string — Handlebars template for the OAuth2 audience parameter - `resource` string — Handlebars template for the OAuth2 resource parameter - `username` string — Handlebars template for the OAuth2 resource owner username. Required when type is oauth2_password. - `password` string — Handlebars template for the OAuth2 resource owner password. Required when type is oauth2_password. - `body_params` object — Additional key-value pairs to include in the token request body. Values support Handlebars templates. - `headers` object — Additional headers to include in the token request. Values support Handlebars templates. - `query_params` object — Additional query parameters to append to the token URL. Values support Handlebars templates. - `params` FileProxyParam[] — Additional use-case-specific parameters expected in the download URL query string (beyond the required orgId, integrationId, and useCaseSlug or useCaseId) - `name` string, required — Parameter name as it appears in the query string - `required` boolean, required — Whether this parameter is required - `description` string — Human-readable description of the parameter - `allowed_origins` string[] — Additional origins permitted to call /download for this use case (CORS, exact match). Portal origins are always allowed. - `steps` FileProxyStep[], required — Ordered list of HTTP steps to execute to retrieve the file - `url` string, required — Handlebars template for the request URL - `method` 'GET' | 'POST', required — HTTP method - `headers` object — Handlebars templates for request headers - `body` string — Handlebars template for the request body (POST only) - `response_type` 'json' | 'binary', required — Expected response type - `response` FileProxyResponseConfig, required - `body` string, required — JSONata expression to extract file content from step results - `encoding` 'base64' | 'binary', required — Encoding of the extracted body - `filename` string — JSONata expression to extract the filename - `content_type` string — JSONata expression to extract the content type - `prevent_indirect_serving` boolean — When `true`, this use case is served via the streaming endpoint: mapped file URLs are built as `/stream/download`, files of any size are streamed inline over HTTP response streaming, and buffered `/download` requests for oversize files are 307-redirected to `/stream`. Files never transit epilot's temporary S3 storage on the streaming path. Defaults to `false` (small files are served directly and large files are transparently served via a temporary S3 redirect). - ManagedCallUseCase - `id` string, uuid, required — Unique identifier for the use case - `integrationId` string, uuid, required — Parent integration ID - `name` string, required — Use case name - `slug` string — URL-safe identifier for the use case. Recommended for portable cross-environment referencing. Unique per integration. Immutable after creation. Lowercase alphanumeric, hyphens, and underscores only. - `type` 'managed_call', required — Use case type for managed API calls - `enabled` boolean, required - `change_description` string — Description of the last change made to this use case - `created_at` string, date-time, required — ISO-8601 timestamp when the use case was created - `updated_at` string, date-time, required — ISO-8601 timestamp when the use case was last updated - `configuration` ManagedCallOperationConfig — Configuration for managed_call use cases. Defines a single API operation with JSONata mapping. - `operation` ManagedCallOperation, required — HTTP operation configuration for managed calls - `method` 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE', required - `path` string, required — URL path template with {{variable}} interpolation - `headers` object — Custom HTTP headers for the request. Values support {{variable}} interpolation from the request payload and {{env.VAR}} references for environment variables. - `query_params` object — Query parameters for the request. Values support {{variable}} interpolation from the request payload. - `request_mapping` string — JSONata expression for outbound body transformation - `response_mapping` string — JSONata expression for inbound response transformation - `inbound_use_case_slug` string — Slug of the inbound use case to route responses to for async entity processing. When set, the managed call response is queued to the inbound pipeline and processed using the referenced inbound use case's mapping configuration. - `type_annotations` TypeAnnotations — Developer-provided type annotations for a use case's request and response fields - `request` object — Type annotations for request fields, keyed by dot-path (e.g., "vendors[].id" -> "string") - `response` object — Type annotations for response fields - `types_locked` boolean — Whether types have been generated for this use case - SecureProxyUseCase - `id` string, uuid, required — Unique identifier for the use case - `integrationId` string, uuid, required — Parent integration ID - `name` string, required — Use case name - `slug` string — URL-safe identifier for the use case. Recommended for portable cross-environment referencing. Unique per integration. Immutable after creation. Lowercase alphanumeric, hyphens, and underscores only. - `type` 'secure_proxy', required — Use case type - `enabled` boolean, required - `change_description` string — Description of the last change made to this use case - `created_at` string, date-time, required — ISO-8601 timestamp when the use case was created - `updated_at` string, date-time, required — ISO-8601 timestamp when the use case was last updated - `configuration` SecureProxyUseCaseConfiguration — Configuration for secure_proxy use cases. Defines how to route requests through a secure VPC. - `vpc_mode` 'static_ip' | 'secure_link', required — VPC routing mode. Read-only after creation. - static_ip: Routes through a VPC with static outbound IP (NAT Gateway) for IP-allowlisted external APIs. - secure_link: Routes through a VPN VPC for accessing private customer networks. - `allowed_domains` string[] — Domain whitelist for secure_link mode. Admin-only — can only be modified directly in DynamoDB via admin script. Supports exact match (e.g., "api.wemag.com") and wildcard prefix (e.g., "*.wemag.com"). - `allowed_ips` string[] — IP allowlist (CIDR notation) for secure_link mode. Admin-only — can only be modified directly in DynamoDB via admin script. Required for secure_link mode. All DNS-resolved IPs must match at least one range. Example: ["10.0.1.0/24", "192.168.1.0/24"] ## Other responses - `400` — Bad request - `401` — Unauthorized request - `404` — Integration not found - `500` — Internal Server Error --- [API](https://skmtc.net/epilot/apis/integration-toolkit-api.md) · [All operations](https://skmtc.net/epilot/apis/integration-toolkit-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/epilot/integration-toolkit-api/revisions/c24837d75096/schema)