Skip to main content

CreateActionRequest

Payload to create or update an automation action

namestringrequired
Example: notify-on-complete
profileIdstringnullable
Example: acme-corp
actionTypeActionType (string)required

Type of automation action to execute

Possible values: [WEBHOOK, KAFKA_PUBLISH, EMAIL, SLACK, ARCHIVE_FILE, CUSTOM_SCRIPT]

Example: WEBHOOK
triggerActionTrigger (string)required

Pipeline event that fires the action

Possible values: [ON_COMPLETION, ON_FAILURE, ON_PARTIAL_FAILURE, ON_THRESHOLD_BREACH, ON_SCHEDULE, MANUAL]

Example: ON_COMPLETION
enabledboolean
Default value: true
config object

Action-specific configuration (URL for WEBHOOK, topic for KAFKA_PUBLISH, etc.)

property name*any

Action-specific configuration (URL for WEBHOOK, topic for KAFKA_PUBLISH, etc.)

Example: {"url":"https://hooks.acme.com/pipeline-complete","method":"POST"}
CreateActionRequest
{
  "name": "notify-on-complete",
  "profileId": "acme-corp",
  "actionType": "WEBHOOK",
  "trigger": "ON_COMPLETION",
  "enabled": true,
  "config": {
    "url": "https://hooks.acme.com/pipeline-complete",
    "method": "POST"
  }
}