Skip to main content
POST
/
automations
/
preview
Previews an automation without side effects.
curl --request POST \
  --url https://api.leadping.ai/automations/preview \
  --header 'Content-Type: application/json' \
  --data '
{
  "automation": {
    "id": "<string>",
    "name": "<string>",
    "description": "<string>",
    "enabled": true,
    "businessId": "<string>",
    "createdByUserId": "<string>",
    "scope": "<string>",
    "visibility": "<string>",
    "managementLevel": "<string>",
    "isSystemManaged": true,
    "triggers": [
      {
        "id": "<string>",
        "type": "<string>",
        "displayName": "<string>",
        "isEnabled": true,
        "settings": {}
      }
    ],
    "conditionGroups": [
      {
        "id": "<string>",
        "mode": "<string>",
        "conditions": [
          {
            "id": "<string>",
            "type": "<string>",
            "operator": "<string>",
            "isEnabled": true,
            "settings": {}
          }
        ]
      }
    ],
    "actions": [
      {
        "id": "<string>",
        "type": "<string>",
        "order": "<string>",
        "isEnabled": true,
        "settings": {}
      }
    ]
  },
  "triggerType": "<string>"
}
'
{
  "triggerType": "<string>",
  "samplePayload": {},
  "validation": {
    "errors": [
      "<string>"
    ],
    "warnings": [
      "<string>"
    ]
  },
  "conditionResults": [
    {
      "conditionId": "<string>",
      "summary": "<string>",
      "passed": true
    }
  ],
  "actionResults": [
    {
      "actionId": "<string>",
      "summary": "<string>",
      "renderedOutput": "<string>",
      "wouldHaveSideEffect": true,
      "warnings": [
        "<string>"
      ]
    }
  ],
  "warnings": [
    "<string>"
  ]
}

Body

The automation preview request payload for the operation.

API DTO containing automation preview data used by Leadping API contracts.

automation
object

The automation value for this automation preview.

triggerType
string | null

The trigger type classification for this automation preview.

Response

Returns the automation preview response.

API DTO containing automation preview response data.

triggerType
string | null

The trigger type classification for this automation preview.

samplePayload
object

The sample payload key-value data carried with this automation preview; values must be safe to expose in API responses.

validation
object

The validation value for this automation preview.

conditionResults
object[]

The condition results included with this automation preview.

actionResults
object[]

The action results included with this automation preview.

warnings
string[]

The warnings included with this automation preview.