Example Webhook Payloads

Example payloads for selected webhook events.

📘

Note

This document provides example payloads for selected webhook events. To view a full list of event types, see Webhook Events.

The data provided in a webhook payload is specific to each event type. In general, a payload contains the following information:

  • Event details
  • User who triggered the event
  • Metadata, such as the fact sheet type, fields, and relations

The maximum supported payload size is 20 MB.

Fact Sheets

FACT_SHEET_CREATED

{
  "id": 42834,
  "type": "FactSheetCreatedEvent",
  "userId": "3et65c21-98f2-5376-acaa-fchf654b9c22",
  "createdAt": "2024-02-16T13:12:27.032622Z",
  "factSheet": {
    "id": "95fbeddd-abdf-4552-a82b-ce37c287735c",
    "rev": 0,
    "name": "AC Management",
    "type": "Application",
    "level": 1,
    "fields": [],
    "status": "ACTIVE",
    "lxState": "BROKEN_QUALITY_SEAL",
    "fullName": "AC Management",
    "naFields": [],
    "createdAt": "2024-02-16T13:12:26.995583770Z",
    "documents": [],
    "relations": [],
    "updatedAt": "2024-02-16T13:12:26.999252278Z",
    "completion": {
      "type": "SectionCompletion",
      "completion": 0.005952380952380952,
      "percentage": 1,
      "totalWeight": 7,
      "weightedSum": 0.041666666666666664,
      "subCompletions": {
        "section.projects": {
          "type": "SectionCompletion",
          "completion": 0,
          "percentage": 0,
          "totalWeight": 1,
          "weightedSum": 0,
          "subCompletions": {
            "subsection.factSheetsAffecting.label": {
              "type": "ConcreteCompletion",
              "completion": 0,
              "percentage": 0,
              "totalWeight": 1,
              "weightedSum": 0
            }
          }
        },
        "section.sourcing": {...},
        "section.information": {...},
        "section.dependencies": {...},
        "section.dataManagement": {...},
        "section.businessSupport": {...},
        "section.lxPortfolioStrategy": {...}
      }
    },
    "milestones": [],
    "displayName": "AC Management",
    "subscriptions": [],
    "permittedReadACL": [],
    "permittedWriteACL": [],
    "lxExcludeFromQuota": false
  },
  "workspaceId": "ae6756f1-4aag-4356-92c6-a390a60cb8fg",
  "clonedFactSheet": false,
  "transactionSequenceNumber": 75086
}

FACT_SHEET_UPDATED

{
  "id": 42844,
  "type": "FactSheetUpdatedEvent",
  "userId": "3et65c21-98f2-5376-acaa-fchf654b9c22",
  "createdAt": "2024-02-16T13:15:23.702272Z",
  "factSheet": {
    "id": "95fbeddd-abdf-4552-a82b-ce37c287735c",
    "rev": 3,
    "name": "AC Management",
    "tags": [...],
    "type": "Application",
    "level": 1,
    "fields": [],
    "status": "ACTIVE",
    "lxState": "BROKEN_QUALITY_SEAL",
    "fullName": "AC Management",
    "naFields": [],
    "createdAt": "2024-02-16T13:12:26.995584Z",
    "documents": [],
    "relations": [],
    "updatedAt": "2024-02-16T13:15:23.678693644Z",
    "completion": {...},
    "milestones": [],
    "description": "AC Management app",
    "displayName": "AC Management",
    "subscriptions": [],
    "permittedReadACL": [],
    "permittedWriteACL": [],
    "lxExcludeFromQuota": false
  },
  "workspaceId": "ae6756f1-4aag-4356-92c6-a390a60cb8fg",
  "transactionSequenceNumber": 75088
}

FACT_SHEET_ARCHIVED

{
  "id": 42914,
  "type": "FactSheetArchivedEvent",
  "fsType": "Application",
  "userId": "3et65c21-98f2-5376-acaa-fchf654b9c22",
  "comment": "Duplicate application",
  "createdAt": "2024-02-16T13:49:42.181834Z",
  "fsIdAndRev": {
    "id": "95fbeddd-abdf-4552-a82b-ce37c287735c",
    "rev": 11
  },
  "workspaceId": "ae6756f1-4aag-4356-92c6-a390a60cb8fg",
  "affectedFactSheetIdAndRev": [
    {
      "id": "95fbeddd-abdf-4552-a82b-ce37c287735c",
      "rev": 11
    },
    {
      "id": "2efa37b5-18aa-48d8-9d70-1328c0d856d7",
      "rev": 27
    }
  ],
  "transactionSequenceNumber": 75126
}

Fact Sheet Relations

RELATION_CREATED

{
  "id": 42846,
  "type": "RelationCreatedEvent",
  "userId": "3et65c21-98f2-5376-acaa-fchf654b9c22",
  "relation": {
    "id": "675aacdd-cfdf-4702-8084-0646e74533b9",
    "toId": "2efa37b5-18aa-48d8-9d70-1328c0d856d7",
    "type": "relToChild",
    "fields": [],
    "fromId": "95fbeddd-abdf-4552-a82b-ce37c287735c",
    "status": "ACTIVE",
    "naFields": [],
    "typeToFS": "Application",
    "typeFromFS": "Application",
    "displayNameToFS": "AC Management / AC Management Cloud",
    "permittedReadACL": [],
    "constrainingRelations": []
  },
  "createdAt": "2024-02-16T13:17:20.965779Z",
  "toDetails": {
    "factSheetInfos": {
      "type": "Application",
      "idAndRev": {
        "id": "2efa37b5-18aa-48d8-9d70-1328c0d856d7",
        "rev": 25
      },
      "displayName": "AC Management / AC Management Cloud"
    },
    "effectiveRelationName": "relToParent"
  },
  "relationId": "675aacdd-cfdf-4702-8084-0646e74533b9",
  "fromDetails": {
    "factSheetInfos": {
      "type": "Application",
      "idAndRev": {
        "id": "95fbeddd-abdf-4552-a82b-ce37c287735c",
        "rev": 3
      },
      "displayName": "AC Management"
    },
    "effectiveRelationName": "relToChild"
  },
  "workspaceId": "ae6756f1-4aag-4356-92c6-a390a60cb8fg",
  "transactionSequenceNumber": 75089
}

Fact Sheet Tags

FACT_SHEET_TAG_ADDED

{
  "id": 42840,
  "type": "FactSheetTagAddedEvent",
  "tagId": "5ab3558a-580b-422d-8a95-12f7f075dfd7",
  "fsType": "Application",
  "userId": "3et65c21-98f2-5376-acaa-fchf654b9c22",
  "tagName": "Public Cloud",
  "createdAt": "2024-02-16T13:14:08.732070Z",
  "fsIdAndRev": {
    "id": "95fbeddd-abdf-4552-a82b-ce37c287735c",
    "rev": 1
  },
  "workspaceId": "ae6756f1-4aag-4356-92c6-a390a60cb8fg",
  "tagGroupName": "Cloud Transformation",
  "transactionSequenceNumber": 75087
}

Fact Sheet Fields

FACT_SHEET_FIELD_UPDATED

{
  "id": 42860,
  "path": "/externalId",
  "type": "FactSheetFieldUpdatedEvent",
  "fsType": "Application",
  "userId": "3et65c21-98f2-5376-acaa-fchf654b9c22",
  "newValue": {
    "type": "ExternalId",
    "status": "ACTIVE",
    "comment": null,
    "externalId": "123456",
    "externalUrl": null
  },
  "oldValue": {
    "type": "ExternalId",
    "status": "ACTIVE",
    "comment": null,
    "externalId": "123456789",
    "externalUrl": null
  },
  "createdAt": "2024-02-16T13:23:03.697933Z",
  "fsIdAndRev": {
    "id": "95fbeddd-abdf-4552-a82b-ce37c287735c",
    "rev": 7
  },
  "workspaceId": "ae6756f1-4aag-4356-92c6-a390a60cb8fg",
  "transactionSequenceNumber": 75093
}

Fact Sheet Resources

DOCUMENT_CREATED

{
  "id": 42851,
  "type": "DocumentCreatedEvent",
  "refId": null,
  "fsType": "Application",
  "userId": "3et65c21-98f2-5376-acaa-fchf654b9c22",
  "createdAt": "2024-02-16T13:19:09.116531Z",
  "documentId": "d2421a7c-b4db-485f-873a-71a354eb7209",
  "fsIdAndRev": {
    "id": "95fbeddd-abdf-4552-a82b-ce37c287735c",
    "rev": 4
  },
  "workspaceId": "ae6756f1-4aag-4356-92c6-a390a60cb8fg",
  "documentName": "Link to LeanIX website",
  "documentType": null,
  "documentOrigin": "CUSTOM_LINK",
  "transactionSequenceNumber": 75090
}

Fact Sheet Subscriptions

SUBSCRIPTION_CREATED

{
  "id": 42854,
  "type": "SubscriptionCreatedEvent",
  "fsType": "Application",
  "userId": "3et65c21-98f2-5376-acaa-fchf654b9c22",
  "createdAt": "2024-02-16T13:20:23.769518Z",
  "roleInfos": [],
  "fsIdAndRev": {
    "id": "95fbeddd-abdf-4552-a82b-ce37c287735c",
    "rev": 6
  },
  "workspaceId": "ae6756f1-4aag-4356-92c6-a390a60cb8fg",
  "subscriptionId": "39aae878-6ded-40de-aa01-9524ce3ee6d0",
  "subscribedUserId": "8393b7a8-8bfb-4989-a348-6cb31d56745f",
  "subscriptionType": "RESPONSIBLE",
  "transactionSequenceNumber": 75091
}

Integration Runs

INTEGRATION_RUN_FINISHED (Integration API)

{
  "type": "INTEGRATION-API",
  "scope": "PARTIAL",
  "version": "1.0.0",
  "duration": 3.924405624,
  "progress": "FINISHED",
  "direction": "INBOUND",
  "errorCount": 0,
  "connectorId": "inbound-document-connector",
  "warningCount": 0,
  "connectorType": "inboundDocument",
  "integratedTool": "",
  "processedCount": 2,
  "synchronizationId": "865b71a1-e66f-49c0-89de-5bc5fb42401b"
}

INTEGRATION_RUN_STARTED (ServiceNow Integration)

{
  "version": "?",
  "type": "SERVICENOW",
  "scope": "PARTIAL",
  "errorCount": 1,
  "warningCount": 2,
  "processedCount": 3,
  "duration": "PT0.123S",
  "progress": "RUNNING",
  "synchronizationId": "18886403-3edb-483d-a13f-cac5f4b34802"
}

INTEGRATION_RUN_FINISHED (ServiceNow Integration)

{
  "version": "?",
  "type": "SERVICENOW",
  "scope": "PARTIAL",
  "errorCount": 1,
  "warningCount": 2,
  "processedCount": 3,
  "duration": "PT0.123S",
  "progress": "FINISHED",
  "synchronizationId": "18886403-3edb-483d-a13f-cac5f4b34802"
}

INTEGRATION_RUN_ABORTED (ServiceNow Integration)

{
  "version": "?",
  "type": "SERVICENOW",
  "scope": "PARTIAL",
  "errorCount": 1,
  "warningCount": 2,
  "processedCount": 3,
  "duration": "PT0.123S",
  "progress": "ABORTED",
  "synchronizationId": "18886403-3edb-483d-a13f-cac5f4b34802"
}

Integration Configurations

CONFIGURATION_CREATED

{
  "type": "CONFIGURATION_CREATED",
  "userId": "3et65c21-98f2-5376-acaa-fchf654b9c22",
  "connectorId": "inbound-document-connector",
  "workspaceId": "ae6756f1-4aag-4356-92c6-a390a60cb8fg",
  "connectorType": "inboundDocument",
  "processingMode": "partial",
  "integrationType": "Integration API",
  "connectorVersion": "1.0.0",
  "processingDirection": "inbound"
}

Automations

AUTOMATION_TRIGGERED

{
  "tag": "AUTOMATION_WEBHOOK_TAG",
  "userId": "6ef78c21-98a2-4377-acaa-fc66ff2b78gf",
  "factSheet": {
    "id": "7a5bace3-4f7c-4682-b511-aecc9a6927d0",
    "type": "Application",
    "displayName": "Test Application Fact Sheet"
  },
  "automation": {
    "id": "3c72aa45-457a-4c10-9fac-40146121167c",
    "sourceUrl": "https://app.leanix.net/workspace-name/admin/automations/edit/3c72aa45-457a-4c10-9fac-40146121167c"
  },
  "workspaceId": "b7d655f1-4aa0-4132-92c6-a390a60cb8gh"
}

Survey Responses

POLL_RESULT_CREATED

{
  "type": "POLL_RESULT_CREATED",
  "pollRun": {
    "id": "0b38d423-7b15-4ecd-ae3e-175c9fb8134a",
    "poll": {
      "id": "3754281a-f8f2-43b5-8ec5-b78465f48be6",
      "title": "Update Life Cycle Dates",
      "status": "ACTIVE",
      "language": "en",
      "creatorId": "3et65c21-98f2-5376-acaa-fchf654b9c22",
      "timeFrame": 0,
      "userQuery": {
        "roles": [
          {
            "roleDetails": [],
            "subscriptionType": "RESPONSIBLE"
          },
          {
            "roleDetails": [],
            "subscriptionType": "OBSERVER"
          }
        ]
      },
      "workspaceId": "ae6756f1-4aag-4356-92c6-a390a60cb8fg",
      "creationDate": "2024-02-16T13:31:19.391993Z",
      "factSheetType": "Application",
      "questionnaire": {
        "id": "5af9a9b9-6da1-465a-bc95-8344b9ec2fb2",
        "questions": [
          {
            "id": "9de72fa1-d999-bff3-eabb-ba3315bb479b",
            "type": "factsheetelement",
            "label": "Update life cycle",
            "deleted": false,
            "disabled": false,
            "powerfeature": true,
            "factSheetElement": {
              "type": "FACT_SHEET_FIELD",
              "factSheetFieldName": "lifecycle",
              "factSheetFieldType": "LIFECYCLE"
            }
          }
        ]
      },
      "factSheetQuery": {
        "ids": [
          "95fbeddd-abdf-4552-a82b-ce37c287735c"
        ],
        "filter": {
          "facetFilter": [
            {
              "keys": [
                "Application"
              ],
              "facetKey": "FactSheetTypes",
              "operator": "OR"
            }
          ]
        }
      },
      "repeatIntervall": 0,
      "introductionText": "...",
      "introductionSubject": "...",
      "additionalFactSheetText": "...",
      "allowedPermissionStatus": "ACTIVE_ONLY",
      "sendChangeNotifications": true,
      "additionalFactSheetSubject": "A Fact Sheet has been added to a Survey you are participating in",
      "additionalFactSheetCheckEnabled": true
    },
    "status": "PREPARING",
    "language": "en",
    "pollCopy": {
      "id": "3754281a-f8f2-43b5-8ec5-b78465f48be6",
      "title": "Update Life Cycle Dates",
      "status": "ACTIVE",
      "language": "en",
      "creatorId": "3et65c21-98f2-5376-acaa-fchf654b9c22",
      "timeFrame": 0,
      "userQuery": {
        "roles": [
          {
            "roleDetails": [],
            "subscriptionType": "RESPONSIBLE"
          },
          {
            "roleDetails": [],
            "subscriptionType": "OBSERVER"
          }
        ]
      },
      "workspaceId": "ae6756f1-4aag-4356-92c6-a390a60cb8fg",
      "creationDate": "2024-02-16T13:31:19.391993Z",
      "factSheetType": "Application",
      "questionnaire": {
        "id": "5af9a9b9-6da1-465a-bc95-8344b9ec2fb2",
        "questions": [
          {
            "id": "9de72fa1-d999-bff3-eabb-ba3315bb479b",
            "type": "factsheetelement",
            "label": "Update life cycle",
            "deleted": false,
            "disabled": false,
            "powerfeature": true,
            "factSheetElement": {
              "type": "FACT_SHEET_FIELD",
              "factSheetFieldName": "lifecycle",
              "factSheetFieldType": "LIFECYCLE"
            }
          }
        ]
      },
      "factSheetQuery": {
        "ids": [
          "95fbeddd-abdf-4552-a82b-ce37c287735c"
        ],
        "filter": {
          "facetFilter": [
            {
              "keys": [
                "Application"
              ],
              "facetKey": "FactSheetTypes",
              "operator": "OR"
            }
          ]
        }
      },
      "repeatIntervall": 0,
      "introductionText": "...",
      "introductionSubject": "...",
      "additionalFactSheetText": "...",
      "allowedPermissionStatus": "ACTIVE_ONLY",
      "sendChangeNotifications": true,
      "additionalFactSheetSubject": "A Fact Sheet has been added to a Survey you are participating in",
      "additionalFactSheetCheckEnabled": true
    },
    "senderId": "3et65c21-98f2-5376-acaa-fchf654b9c22",
    "startTime": "2024-02-16T13:40:56.246318Z",
    "resultView": "NEW",
    "pollRunType": "LIVE",
    "pollResultType": "PER_FACTSHEET",
    "factsheetsTotal": 1,
    "recipientsTotal": 2,
    "factsheetsProgress": 0,
    "factsheetsSelected": 1,
    "recipientsProgress": 0,
    "factsheetsCompleted": 0,
    "recipientsCompleted": 0,
    "sendChangeNotifications": true,
    "additionalFactSheetCheckEnabled": true
  },
  "createdAt": 1708090856819,
  "pollResult": {
    "id": "1eda2425-2d33-4c5e-a3e3-7f767770b778",
    "users": [
      {
        "id": "8393b7a8-8bfb-4989-a348-6cb31d56745f",
        "email": "[email protected]",
        "fullName": "John Smith",
        "lastName": "Smith",
        "firstName": "John"
      },
      {
        "id": "3et65c21-98f2-5376-acaa-fchf654b9c22",
        "email": "[email protected]",
        "fullName": "John Doe",
        "lastName": "Doe",
        "firstName": "John"
      }
    ],
    "sender": {
      "id": "3et65c21-98f2-5376-acaa-fchf654b9c22",
      "email": "[email protected]",
      "fullName": "John Doe",
      "lastName": "Doe",
      "firstName": "John"
    },
    "status": "NEW",
    "answers": [
      {
        "questionId": "9de72fa1-d999-bff3-eabb-ba3315bb479b"
      }
    ],
    "factSheet": {
      "id": "95fbeddd-abdf-4552-a82b-ce37c287735c",
      "name": "AC Management",
      "type": "Application",
      "displayName": "AC Management App"
    },
    "pollRunId": "0b38d423-7b15-4ecd-ae3e-175c9fb8134a"
  },
  "workspaceId": "ae6756f1-4aag-4356-92c6-a390a60cb8fg",
  "pollResultEventType": "POLL_RESULT_CREATED"
}