Salesforce Pub/Sub API

Subscribe to and publish Salesforce platform events and Change Data Capture events via the gRPC-based Pub/Sub API.

Subscriber

- salesforce_pubsubapi_subscriber:
    name: account_changes
    credentials_path: /etc/salesforce/credentials.json
    topic:
      name: /data/AccountChangeEvent
      num_requested: 100
      durable_consumer_options:
        enabled: true
        managed_subscription: true
        name: flowgen_account_sub
        replay_preset: latest

Subscriber fields

FieldTypeDefaultDescription
namestringrequiredTask name.
credentials_pathstringrequiredPath to Salesforce credentials.
topic.namestringrequiredTopic name (e.g., /data/AccountChangeEvent).
topic.num_requestedintMessages per batch.
topic.durable_consumer_optionsobjectDurable consumer settings (see below).
endpointstringCustom Pub/Sub API endpoint.
ack_timeoutdurationFlow completion timeout.
depends_onlistUpstream task names.
retryobjectRetry configuration.

Durable consumer options

FieldTypeDefaultDescription
enabledboolrequiredEnable durable consumer.
managed_subscriptionboolSalesforce manages the subscription lifecycle.
namestringrequiredConsumer name.
replay_presetstringlatestStart position: latest or earliest.

Publisher

- salesforce_pubsubapi_publisher:
    name: publish_event
    credentials_path: /etc/salesforce/credentials.json
    topic: /event/Order_Update__e
    payload:
      Order_Id__c: "{{event.data.order_id}}"
      Status__c: "{{event.data.status}}"

Publisher fields

FieldTypeDefaultDescription
namestringrequiredTask name.
credentials_pathstringrequiredPath to Salesforce credentials.
topicstringrequiredTarget topic name.
payloadobjectrequiredEvent payload — explicit fields or from_event: true.
endpointstringCustom Pub/Sub API endpoint.
depends_onlistUpstream task names.
retryobjectRetry configuration.