Sign in

v1

latestOpenAPI 3.1.0Apache 2.02026-07-245981,1853.0 MB
Workflows V2

Export Workflow

Use this API to export an integration workflow as a JSON file.

get/v2/workflows/export

Query parameters

workflowNamestring required

Name of the workflow to export.

Response

OK

formatVersionstring

Version of the workflow definition format.

namestring required

Workflow name.

descriptionstring

Workflow description.

enabledboolean

Whether this workflow is enabled.

workflowType'CUSTOM' | 'COMPOSITE' | 'CONFIG' | 'PRESET' required

Workflow type.

integrationNamestring

Integration name that owns this workflow.

referenceIntegrationNamestring

Reference integration name when this is a template workflow.

dlqEnabledboolean

Whether Dead Letter Queue (DLQ) is enabled for this workflow.

sourceType'SEED' | 'USER_DEFINED' | 'INSTANCE' | 'PRESET_INSTANCE' | 'RULE' | 'CUSTOM_WIZARD_WORKFLOW' | 'EMBEDDED'

Integration source type.

processType'HTTP' | 'FTP' | 'FILEPARSER' | 'FILEGENERATOR' | 'TRANSFORM' | 'SOURCE' | 'SQL' | 'SINK' | 'MESSAGELOG' | 'CONDITION' | 'APPLYEACH' | 'EMAILACTION' | 'PAGINATION' | 'FILEUPLOAD' | 'SUBFLOW' | 'HTTPFILEUPLOAD' | 'DOWHILE' | 'SOAPACTION' | 'SDKACTION'

Process type for this workflow node.

throttlingLimitinteger

Maximum concurrent executions (throttle limit) for the workflow.

defaultDlqAction'NONE' | 'PURGE' | 'REPROCESS'

Default action when a DLQ event occurs (NONE, PURGE, or REPROCESS).

Example response

{
  "formatVersion": "V2.0",
  "name": "Customer Data Sync",
  "description": "Workflow to sync customer data from CRM to database",
  "enabled": true,
  "workflowType": "CUSTOM",
  "integrationName": "Salesforce",
  "referenceIntegrationName": "Salesforce-Template",
  "dlqEnabled": true,
  "sourceType": "INSTANCE",
  "processType": "HTTP",
  "throttlingLimit": 100,
  "defaultDlqAction": "REPROCESS",
  "trigger": {
    "name": "New Customer Signup",
    "workflowName": "Customer Onboarding",
    "workflowId": "123e4567-e89b-12d3-a456-426614174000",
    "triggerType": "EVENT",
    "description": "Triggered when a new customer signs up",
    "eventCode": "CUSTOMER_SIGNUP"
  }
}