{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":[]},"redocly_category":"Journeys","product":"Identity Management","type":"markdown"},"seo":{"title":"Additional data reporting","description":"Everything about Mosaic Journeys, SDKs, and APIs","siteUrl":"https://developer.transmitsecurity.com/","llmstxt":{"hide":false,"sections":[{"title":"Table of contents","includeFiles":["**/*"],"excludeFiles":[]}],"excludeFiles":[]}},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"additional-data-reporting","__idx":0},"children":["Additional data reporting"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["As journeys run, each step emits activity events that include standard metadata that you can inspect in the ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/guides/orchestration/getting-started/journey_analytics"},"children":["Journey analytics"]}," and in the ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/guides/user/user_audit_logs"},"children":["User activity"]}," log, or stream via ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/openapi/risk/activities.openapi"},"children":["Activities APIs"]}," to external monitoring systems."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["For diagnostic purposes or deeper troubleshooting, you can configure journey steps (except Success/Reject steps) and some external connectors to record additional data and extend their standard activity events."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"report-step-data","__idx":1},"children":["Report step data"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["In each step's ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Step data & reporting"]}," settings, you can enable ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Report Step Data"]}," to include additional data in the related ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Step completed"]}," event."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Use ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Step Input & Output"]}," to record the step-specific data received and produced by that step during the journey execution. Use ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Custom Data"]}," to record a payload that you define with an authscript expression, such as selected fields, derived values, or a smaller diagnostic object tailored to your investigation."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The step-level configurations are:"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"table"},"children":[{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Field"},"children":["Field"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Report Step Data"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Enables additional event reporting for the step."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Data Reported"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Determines whether the step records:",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Step Input & Output"]},"—the step-specific input and output metadata."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Custom Data"]},"—an authscript expression that defines the custom payload recorded for the step."]}]}," For syntax details, see ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/guides/orchestration/getting-started/expressions/overview"},"children":["About expressions"]}," and ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/guides/orchestration/getting-started/expressions/constructors"},"children":["Expressions: Constructors"]},"."]}]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"report-external-connectors-data","__idx":2},"children":["Report external connectors data"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["When integrating external services into journeys using external connectors, such as ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/guides/orchestration/external-connections/web_service_function"},"children":["Custom HTTP"]},", ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/guides/orchestration/external-connections/custom_web_service_email"},"children":["Custom server for emails"]},", ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/guides/orchestration/external-connections/custom_web_service_sms"},"children":["Custom web services for SMS"]},", and ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/guides/orchestration/external-connections/custom_web_service_push"},"children":["Custom provider for push notifications"]},", you can report external connector data for troubleshooting the integration, validating request mappings, or checking how a third-party service responded during a journey execution."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Use ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["External Connect Request/Response"]}," to record the request sent by the connector and the response returned by the external service during the journey execution. Use ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Custom"]}," to record a payload that you define with an expression, such as selected headers, response fields, derived values, or a smaller diagnostic object tailored to your investigation."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The connector-level configurations are:"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"table"},"children":[{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Field"},"children":["Field"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Report External Connection Data"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Enables additional event reporting for the connector."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Data Reported"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Determines whether the connector records ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["External Connect Request/Response"]}," or ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Custom"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Custom Data Reported"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Expression that defines the custom payload recorded for the connector. For syntax details, see ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/guides/orchestration/getting-started/expressions/overview"},"children":["About expressions"]}," and ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/guides/orchestration/getting-started/expressions/constructors"},"children":["Expressions: Constructors"]},"."]}]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["When connector payloads may include sensitive values, prefer a custom payload that records only the fields needed for investigation."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"best-practices","__idx":3},"children":["Best practices"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Keep additional journey event data off by default. Enable it only for the steps or connectors where the extra context is needed for troubleshooting, monitoring, or forensic analysis."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Prefer stable field names in custom payloads so logs remain easy to search and compare across executions."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Avoid recording secrets or unnecessary personal data. There is no automatic global filter for sensitive data, so use ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Custom Data"]}," to define explicitly which fields are recorded."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"reported-data-example","__idx":4},"children":["Reported data example"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The reported additional data is surfaced in the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Step completed"]}," events in fragments such as the following:"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"inputs--outputs","__idx":5},"children":["Inputs & Outputs"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"\"step_data\": {\n  \"step_input\": {\n    \"name\": {},\n    \"username\": {\n      \"raw\": \"@uuid()\",\n      \"evaluated\": \"7bc6cc96-dd05-455e-a8c9-949c5257c5d5\"\n    },\n    \"secondary_emails\": [],\n    \"address\": {}\n  },\n  \"step_output\": {\n    \"result\": {\n      \"user_id\": \"BWhayr_JWxLGiI6K22wRG\",\n      \"created_at\": 1779274063221,\n      \"updated_at\": 1779274063221,\n      \"status\": \"Pending\",\n      \"app_id\": \"xvxo4bqhu9PGMkE772AdN\",\n      \"username\": \"7bc6cc96-dd05-455e-a8c9-949c5257c5d5\",\n      \"app_name\": \"Acme LTD\"\n    }\n  }\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"custom-data","__idx":6},"children":["Custom data"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"\"step_data\": {\n  \"custom\": {\n    \"variables\": [\n      {\n        \"name\": \"ClientID\",\n        \"value\": {\n          \"raw\": \"@policy.clientInfo().client_id\",\n          \"evaluated\": \"BWhayr_JWxLGiI6K22wRG\"\n        }\n      }\n    ]\n  }\n}\n","lang":"json"},"children":[]}]},"headings":[{"value":"Additional data reporting","id":"additional-data-reporting","depth":1},{"value":"Report step data","id":"report-step-data","depth":2},{"value":"Report external connectors data","id":"report-external-connectors-data","depth":2},{"value":"Best practices","id":"best-practices","depth":2},{"value":"Reported data example","id":"reported-data-example","depth":2},{"value":"Inputs & Outputs","id":"inputs--outputs","depth":4},{"value":"Custom data","id":"custom-data","depth":4}],"frontmatter":{"markdown":{"toc":{"depth":2}},"seo":{"title":"Additional data reporting"}},"lastModified":"2026-05-26T06:26:01.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/guides/orchestration/getting-started/event_reporting","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}