salesforce update sink Salesforce Update Sink

Provided by: "Apache Software Foundation"

Support Level for this Kamelet is: "Preview"

Updates an object in Salesforce. The body received must contain a JSON key-value pair for each property to update and sObjectName and sObjectId must be provided as parameters.

Example of key-value pair: { "Phone": "1234567890", "Name": "Antonia" }

Configuration Options

The following table summarizes the configuration options available for the salesforce-update-sink Kamelet:

Property Name Description Type Default Example

clientId

Consumer Key

Required The Salesforce application consumer key.

string

clientSecret

Consumer Secret

Required The Salesforce application consumer secret.

string

password

Password

Required The Salesforce user password.

string

sObjectId

Object Id

Required Id of the object. Only required if using key-value pair.

string

sObjectName

Object Name

Required Type of the object. Only required if using key-value pair.

string

Contact

userName

Username

Required The Salesforce username.

string

loginUrl

Login URL

The Salesforce instance login URL.

string

https://login.salesforce.com

Dependencies

At runtime, the salesforce-update-sink Kamelet relies upon the presence of the following dependencies:

  • camel:salesforce

  • camel:kamelet

Usage

This section describes how you can use the salesforce-update-sink.

Knative sink

You can use the salesforce-update-sink Kamelet as a Knative sink by binding it to a Knative object.

salesforce-update-sink-binding.yaml
apiVersion: camel.apache.org/v1alpha1
kind: KameletBinding
metadata:
  name: salesforce-update-sink-binding
spec:
  source:
    ref:
      kind: Channel
      apiVersion: messaging.knative.dev/v1
      name: mychannel
  sink:
    ref:
      kind: Kamelet
      apiVersion: camel.apache.org/v1alpha1
      name: salesforce-update-sink
    properties:
      clientId: The Consumer Key
      clientSecret: The Consumer Secret
      password: The Password
      sObjectId: The Object Id
      sObjectName: Contact
      userName: The Username

Prerequisite

You have Camel K installed on the cluster.

Procedure for using the cluster CLI

  1. Save the salesforce-update-sink-binding.yaml file to your local drive, and then edit it as needed for your configuration.

  2. Run the sink by using the following command:

    kubectl apply -f salesforce-update-sink-binding.yaml

Procedure for using the Kamel CLI

Configure and run the sink by using the following command:

kamel bind salesforce-update-sink -p "sink.clientId=The Consumer Key" -p "sink.clientSecret=The Consumer Secret" -p "sink.password=The Password" -p "sink.sObjectId=The Object Id" -p "sink.sObjectName=Contact" -p "sink.userName=The Username" channel:mychannel

This command creates the KameletBinding in the current namespace on the cluster.

Kafka sink

You can use the salesforce-update-sink Kamelet as a Kafka sink by binding it to a Kafka topic.

salesforce-update-sink-binding.yaml
apiVersion: camel.apache.org/v1alpha1
kind: KameletBinding
metadata:
  name: salesforce-update-sink-binding
spec:
  source:
    ref:
      kind: KafkaTopic
      apiVersion: kafka.strimzi.io/v1beta1
      name: my-topic
  sink:
    ref:
      kind: Kamelet
      apiVersion: camel.apache.org/v1alpha1
      name: salesforce-update-sink
    properties:
      clientId: The Consumer Key
      clientSecret: The Consumer Secret
      password: The Password
      sObjectId: The Object Id
      sObjectName: Contact
      userName: The Username

Prerequisites

  • You’ve installed Strimzi.

  • You’ve created a topic named my-topic in the current namespace.

  • You have Camel K installed on the cluster.

Procedure for using the cluster CLI

  1. Save the salesforce-update-sink-binding.yaml file to your local drive, and then edit it as needed for your configuration.

  2. Run the sink by using the following command:

    kubectl apply -f salesforce-update-sink-binding.yaml

Procedure for using the Kamel CLI

Configure and run the sink by using the following command:

kamel bind salesforce-update-sink -p "sink.clientId=The Consumer Key" -p "sink.clientSecret=The Consumer Secret" -p "sink.password=The Password" -p "sink.sObjectId=The Object Id" -p "sink.sObjectName=Contact" -p "sink.userName=The Username" kafka.strimzi.io/v1beta1:KafkaTopic:my-topic

This command creates the KameletBinding in the current namespace on the cluster.

Kamelet source file

https://github.com/apache/camel-kamelets/blob/main/kamelets/salesforce-update-sink.kamelet.yaml

Back to top