PubSubPublish
Task to publish salesforce messages with a Pub/Sub API
Task version: 1.0.0
Required Frends version: 5.7+
Required .NET version: 8.0
Compatible Agents: Crossplatform
Source code: https://github.com/FrendsPlatform/Frends.Salesforce/tree/main/Frends.Salesforce.PubSubPublish
Task Parameters
TopicName : String
The topic or event name to publish to.
Default: -
Example: MyCustomEvent__e
Payload : String
The message payload to send in Json format correct with topic schema.
Default: -
Example: { "field": "value" }
Headers : List<Header>
Optional headers to include with the message.
Default: -
Example: object[] { object { string Key, string Value } }
AuthenticationMethod : AuthenticationMethod
Authentication method used to get a Salesforce access token.
Possible values:
AccessToken: Authenticate with an access token.OAuth2WithPassword: Authenticate by providing required information to fetch OAuth2 access token.OAuth2WithClientCredentials: Authenticate using OAuth2 client credentials grant flow.
Default: OAuth2WithPassword
Example: UsernamePasswordOAuth
PubSubApiUrl : String
Salesforce Pub/Sub API endpoint.
Default: -
Example: https://api.pubsub.salesforce.com:7443
InstanceUrl : String
Salesforce instance URL. Required when using the AccessToken authentication method.
Default: -
Example: https://mydomain.my.salesforce.com
AuthUrl : String
Url used to authenticate to Salesforce with the OAuth2 password flow.
Default: https://login.salesforce.com
Example: https://mydomain.my.salesforce.com
TenantId : String
Salesforce tenant or org ID. Sent as the tenantId gRPC header.
Default: -
Example: 00Dxx0000000001
🗝AccessToken : String
Reusable Salesforce access token. Required when using the AccessToken authentication method.
Default: -
Example: 00Dxx0000000001!AQ8AQExampleToken
ClientId : String
OAuth connected app client ID.
Default: -
Example: 3MVG9d8..ExampleClientId
🗝ClientSecret : String
OAuth connected app client secret.
Default: -
Example: ExampleClientSecret
Username : String
Salesforce username.
Default: -
Example: integration.user@example.com
🗝Password : String
Salesforce password.
Default: -
Example: ExamplePassword
🗝SecurityToken : String
Salesforce security token appended to the password for the username-password OAuth flow when required.
Default: -
Example: ExampleSecurityToken
ShutdownChannel : Boolean
Allows keeping a channel for connection open.
Speed up multiple calls, but needs to be closed at last usage.
Default: True
Example: true
ThrowErrorOnFailure : Boolean
Whether to throw an error on failure.
Default: True
Example: true
ErrorMessageOnFailure : String
Overrides the error message on failure.
Default: -
Example: Custom error message
Task Result
Success : Boolean
Indicates if the publish operation completed successfully. True if successful, otherwise false.
Example: true
MessageId : String
The ID of the published message (if available). Base64-encoded replay ID.
Example: "MTIzNDU2"
Error : Error
Error that occurred during task execution. Error details or null if none.
Example: null
Error.Message : String
Summary of the error.
Example: Unable to publish message.
Error.AdditionalInfo : Exception
Additional information about the error.
Example: object { Exception AdditionalInfo }
Task Changelog
Changelog for Task Frends.Salesforce.PubSubPublish.
[1.0.0] - 2026-04-26
Added
Initial implementation
Last updated
Was this helpful?