Salesforce Delete Sink
Provided by: "Apache Software Foundation"
Support Level for this Kamelet is: "Stable"
Deletes the Salesforce record that each message names by its ID, such as a contact or an account.
Use it to remove records from Salesforce when they are removed in another system, for example to delete a contact when a customer closes their account.
Input: the body is JSON text with two fields: sObjectName, the API name of the kind of record (such as Contact), and sObjectId, the ID of the record. For example {"sObjectName": "Contact", "sObjectId": "003XXXXXXXXXXXXXXX"}. Other fields are ignored.
Output: when it is used inside a route, the body afterwards is empty.
Good to know: Salesforce moves the deleted record to its Recycle Bin. A message without sObjectName or sObjectId, or for a record that does not exist, fails. The message decides which record is deleted, so place this sink only after a source you trust. Headers that start with CamelSalesforce are removed from the message first, so they cannot change what the Kamelet does.
Configuration Options
The following table summarizes the configuration options available for the salesforce-delete-sink Kamelet:
| Property | Name | Description | Type | Default | Example |
|---|---|---|---|---|---|
Consumer Key | Required The consumer key of the connected app that the Kamelet logs in through. In Salesforce Setup, open App Manager, choose View on the app, then Manage Consumer Details. | string | |||
Consumer Secret | Required The consumer secret of the same connected app, shown next to the consumer key under Manage Consumer Details. | string | |||
Authentication Type | How the Kamelet logs in. Enum values: * USERNAME_PASSWORD * CLIENT_CREDENTIALS * REFRESH_TOKEN * JWT | string | USERNAME_PASSWORD | ||
Instance URL | The address of your org, such as | string | https://myinstance.my.salesforce.com | ||
JWT Audience | The audience of the JWT that the Kamelet signs to log in: | string | https://login.salesforce.com | ||
Keystore | A reference to a bean of type | string | #bean:myKeystore | ||
Login URL | The address the Kamelet logs in to. Keep the default for a production org, use | string | https://test.salesforce.com | ||
Password | The password of | string | |||
Refresh Token | A refresh token of the connected app for the user to act as, obtained once through an OAuth login in a browser with the | string | |||
Username | The user name of the Salesforce user to log in as, which looks like an email address. Used by the | string |
Dependencies
At runtime, the salesforce-delete-sink Kamelet relies upon the presence of the following dependencies:
-
camel:salesforce
-
camel:kamelet
-
camel:jsonpath
Camel JBang usage
Prerequisites
-
You’ve installed JBang.
-
You have executed the following command:
jbang app install camel@apache/camel Supposing you have a file named route.yaml with this content:
- route:
from:
uri: "kamelet:timer-source"
parameters:
period: 10000
message: 'test'
steps:
- to:
uri: "kamelet:salesforce-delete-sink" You can now run it directly through the following command
camel run route.yaml Salesforce Delete Sink Kamelet Description
Salesforce CRM Integration
This Kamelet integrates with Salesforce CRM to delete records. It provides record deletion through Salesforce’s REST API.
Record Deletion
Each message names the record to delete, as JSON text:
{
"sObjectName": "Contact",
"sObjectId": "003XXXXXXXXXXXXXXX"
} -
sObjectName: the API name of the kind of record -
sObjectId: the Salesforce ID of the record
Because the message decides which record is deleted, place this Kamelet only after a source you trust.
Safety and Recovery
Salesforce provides safety mechanisms for deleted records:
-
Deleted records are moved to the Recycle Bin
-
Records can be restored within the retention period
-
Audit trails maintain deletion history
Cascade Effects
Salesforce’s cascade deletion rules apply: deleting a record can also delete related records, as the relationships of your org define.
API Authentication
The Kamelet logs in through a connected app of your org. Create one in Salesforce Setup, under App Manager, with OAuth enabled, and copy its consumer key and secret into clientId and clientSecret. authenticationType chooses how the Kamelet logs in, and which other options it needs.