Salesforce Tooling API

Manage Salesforce metadata. Currently supports creating managed event subscriptions for Change Data Capture.

Configuration

- salesforce_toolingapi:
    name: create_subscription
    operation: create_managed_event_subscription
    credentials_path: /etc/salesforce/credentials.json
    full_name: AccountChangeEvent_flowgen
    metadata:
      label: Account CDC Subscription
      topic_name: /data/AccountChangeEvent
      default_replay: latest
      state: run
      error_recovery_replay: latest

Fields

FieldTypeDefaultDescription
namestringrequiredTask name.
operationstringrequiredcreate_managed_event_subscription.
credentials_pathstringrequiredPath to Salesforce credentials.
full_namestringAPI name for the subscription.
metadataobjectSubscription metadata (see below).
depends_onlistUpstream task names.
retryobjectRetry configuration.

Metadata fields

FieldTypeDescription
labelstringHuman-readable label.
topic_namestringCDC topic (e.g., /data/AccountChangeEvent).
default_replaystringlatest or earliest.
statestringrun or stop.
error_recovery_replaystringlatest or earliest.