Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix readme #154

Merged
merged 1 commit into from
Nov 12, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 15 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,15 +26,15 @@ Conduit Source and Destination Connector uses [PubSub API](https://developer.sal

##### Platform Events

The connector is capable of listening to [custom Platform Events](https://developer.salesforce.com/docs/atlas.en-us.platform_events.meta/platform_events/platform_events_intro.htm).
The connector is capable of listening to [custom Platform Events](https://developer.salesforce.com/docs/atlas.en-us.platform_events.meta/platform_events/platform_events_intro.htm).

Platform Events in Salesforce are part of the event-driven architecture, allowing for the exchange of real-time event data between applications. They enable asynchronous communication and data transfer between Salesforce and external systems, as well as among various Salesforce components. Users can define custom Platform Events based on their specific use cases, to which the connector can subscribe. Additionally, users can subscribe to already [existing events](https://developer.salesforce.com/docs/atlas.en-us.platform_events.meta/platform_events/platform_events_objects_list.htm).

For more information on how to create Platform Events, visit the following link:
For more information on how to create Platform Events, visit the following link:
[Creating Platform Events](https://developer.salesforce.com/docs/atlas.en-us.platform_events.meta/platform_events/platform_events_publish.htm)


###### Setting Platform Events from a Flow
###### Setting Platform Events from a Flow

Steps to Create Platform Events

Expand All @@ -56,23 +56,23 @@ The connector authenticates with Salesforce using OAuth credentials. Once succes
- `AccessToken` - token used in Streaming API requests.
- `Instance URL` - Streaming API base URL for given credentials.

##### Connected App Configuration
##### Connected App Configuration

1. Log in into Your Salesforce account, e.g. https://my-demo-app.my.salesforce.com. The environment is `my-demo-app`.
2. First, if not already done, You need to create connected app and enable following settings:
Under **API (Enable OAuth Settings)**
2. First, if not already done, You need to create connected app and enable following settings:

Under **API (Enable OAuth Settings)**
- Enable `Enable OAuth Settings`
- Add the following permissions for Selected OAuth Scope:
- `Access the Salesforce API Platform`
- `Perform requests at any time`
- `Perform requests at any time`
- Enable `Require Proof Key for Code Exchange (PKCE) Extension for Supported Authorization Flows`
- Enable `Require Secret for Web Server Flow`
- Enable `Require Secret for Refresh Token Flow`
- Enable `Enable Client Credentials Flow`


Under **Custom Connected App Handler**
Under **Custom Connected App Handler**
- On `Run As` select a user with 'API Enabled' permission privileges. (If user doesn't have them, you can add them under Permission Sets on User settings)

![Connected App example](docs/connected_app.png)
Expand All @@ -81,13 +81,13 @@ The connector authenticates with Salesforce using OAuth credentials. Once succes
![View OAuth tokens](docs/view_oauth_tokens.png)


4. Once the app is created, go to _Connected Apps -> Manage Connected Apps_ and edit the application.
Under **Client Credentials Flow**
4. Once the app is created, go to _Connected Apps -> Manage Connected Apps_ and edit the application.
Under **Client Credentials Flow**
- On `Run As` select a user with 'API Enabled' permission privileges. (If user doesn't have them, you can add them under Permission Sets on User settings)

### Error handling

The connector will report any errors at startup if authentication credentials are incorrect, which may lead to a server request rejection.
The connector will report any errors at startup if authentication credentials are incorrect, which may lead to a server request rejection.

If any specified Platform Events do not exist, Salesforce will reject the subscription, resulting in connector failure.

Expand All @@ -98,7 +98,7 @@ While the connector is operational, it may be necessary to reconnect. The server

### Configuration Options

With the above set up followed, you can begin configuring the source or destination connector. Refer to the table below on which values to set.
With the above set up followed, you can begin configuring the source or destination connector. Refer to the table below on which values to set.

Additionally, on the destination connector, verify that the source record’s data fields align with those of the event it’s being published to. You can include or exclude fields from the data as necessary using Conduit Processors.

Expand Down Expand Up @@ -127,10 +127,10 @@ The following data is included:
- `CreatedAt` - Event's Creation Date, generated by Salesforce.
- `Metadata.channel` - A channel name of the event.
- `Metadata.replyId` - Event's Replay ID.
- `Metadata.action` - Event's action, i.e. the reason why notification was sent. Currently, all events will be marked a created.
- `Metadata.action` - Event's action, i.e. the reason why notification was sent. Currently, all events will be marked a created.


## Destination
#### Destination

| name | description | required | default |
|-------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------|---------|
Expand Down