Chat with Cohere API on New Outbound Message (Instant) from Salesforce API

Pipedream makes it easy to connect APIs for Cohere, Salesforce and 2,400+ other apps remarkably fast.

Trigger workflow on

New Outbound Message (Instant) from the Salesforce API

Next, do this

Chat with the Cohere API

No credit card required

▶

Watch us build a workflow

8 min

Watch now ➜

Trusted by 1,000,000+ developers from startups to Fortune 500 companies

Developers ♥ Pipedream

Getting Started#

This integration creates a workflow with a Salesforce trigger and Cohere action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Outbound Message (Instant) trigger
1. Connect your Salesforce account
2. Configure infoBox
Configure the Chat action
1. Connect your Cohere account
2. Configure Message
3. Optional- Select a Model
4. Optional- Configure Temperature
5. Optional- Configure Max Tokens
6. Optional- Configure K
7. Optional- Configure P
8. Optional- Configure Stop Sequences
9. Optional- Configure Frequency Penalty
Deploy the workflow
Send a test event to validate your setup
Turn on the trigger

Details#

This integration uses pre-built, source-available components from Pipedream's GitHub repo. These components are developed by Pipedream and the community, and verified and maintained by Pipedream.

To contribute an update to an existing component or create a new component, create a PR on GitHub. If you're new to Pipedream component development, you can start with quickstarts for trigger span and action development, and then review the component API reference.

Trigger#

New Outbound Message (Instant) on Salesforce

Description:Emit new event when a new outbound message is received in Salesforce.

Version:0.1.7

Key:salesforce_rest_api-new-outbound-message

View on GitHub

Salesforce Overview#

The Salesforce (REST API) provides a powerful platform for creating and managing customer relationships with a wide array of features like data manipulation, querying, and complex automation. With Pipedream's serverless execution, you can create workflows that automate your sales processes, sync data with other platforms, enhance customer engagement, and trigger actions based on specific events. Dive into Salesforce data, streamline lead management, track customer interactions, and push or pull data to or from Salesforce seamlessly.

Trigger Code#

import { XMLParser } from "fast-xml-parser";
import salesforce from "../../salesforce_rest_api.app.mjs";

export default {
  type: "source",
  name: "New Outbound Message (Instant)",
  key: "salesforce_rest_api-new-outbound-message",
  description: "Emit new event when a new outbound message is received in Salesforce.",
  version: "0.1.7",
  dedupe: "unique",
  props: {
    db: "$.service.db",
    http: {
      type: "$.interface.http",
      customResponse: true,
    },
    salesforce,
    infoBox: {
      type: "alert",
      alertType: "info",
      content: `See Salesforce's guide on [setting up Outbound Messaging](https://sforce.co/3JbZJom).
\\
Set the Outbound Message's \`Endpoint URL\` to the endpoint of this source, which you can view after it is created.
\\
The \`Send Session ID\` option must be enabled in Salesforce for validating outbound messages.`,
    },
  },
  methods: {
    _unwrapMessage(message) {
      const parser = new XMLParser({
        removeNSPrefix: true,
      });
      const obj = parser.parse(message);
      const notifications = obj["Envelope"]["Body"].notifications;
      return notifications;
    },
    _sendHttpResponse(successValue = true, status) {
      // eslint-disable-next-line multiline-ternary
      status = status ?? (successValue ? 200 : 400);
      this.http.respond({
        status,
        body: `
          <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
          xmlns:out="http://soap.sforce.com/2005/09/outbound">
            <soapenv:Header/>
            <soapenv:Body>
              <out:notificationsResponse>
                <out:Ack>${successValue}</out:Ack>
              </out:notificationsResponse>
            </soapenv:Body>
          </soapenv:Envelope>
        `,
        headers: {
          "content-type": "text/xml",
        },
      });
    },
    async _isValidSessionId(sessionId) {
      try {
        const data = await this.salesforce.getUserInfo(sessionId);
        return Boolean(data);
      } catch (err) {
        console.log("Error validating SessionId:", err);
        return false;
      }
    },
    async _isValidSource(data) {
      const { SessionId: sessionId } = data;
      if (!sessionId) {
        throw new Error("The outbound message is missing a Session ID. Please configure the outbound message to send Session ID to validate the webhook source.");
      }

      return this._isValidSessionId(sessionId);
    },
    generateMeta(data) {
      const {
        ActionId: actionId,
        Notification: { Id: eventId },
      } = data;
      const id = `${eventId}-${actionId}`;
      const summary = JSON.stringify(data);
      const ts = Date.now();
      return {
        id,
        summary,
        ts,
      };
    },
  },
  async run(event) {
    const { bodyRaw } = event;
    this._sendHttpResponse(true);
    const data = this._unwrapMessage(bodyRaw);
    if (!(await this._isValidSource(data))) {
      console.log("Skipping event from unrecognized source");
      return;
    }

    let notifications = data.Notification;
    if (!Array.isArray(notifications)) {
      notifications = [
        data.Notification,
      ];
    }

    notifications.forEach((n) => {
      const notification = Object.assign(data, {
        Notification: n,
      });
      this.$emit(notification, this.generateMeta(notification));
    });
  },
};

Trigger Configuration#

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI and CLI.

Label	Prop	Type	Description
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
N/A	`http`	`$.interface.http`	This component uses `$.interface.http` to generate a unique URL when the component is first instantiated. Each request to the URL will trigger the `run()` method of the component.
Salesforce	`salesforce`	`app`	This component uses the Salesforce app.

Trigger Authentication#

Salesforce uses OAuth authentication. When you connect your Salesforce account, Pipedream will open a popup window where you can sign into Salesforce and grant Pipedream permission to connect to your account. Pipedream securely stores and automatically refreshes the OAuth tokens so you can easily authenticate any Salesforce API.

Pipedream requests the following authorization scopes when you connect your account:

About Salesforce#

Web services API for interacting with Salesforce

Action#

Chat on Cohere

Description:Generates a text response to a user message. [See the documentation](https://docs.cohere.com/reference/chat)

Version:0.0.1

Key:cohere_platform-chat

View on GitHub

Cohere Overview#

The Cohere API enables the development of apps with advanced natural language understanding capabilities. Utilizing machine learning, it can help with tasks like text generation, summarization, sentiment analysis, and more. On Pipedream, you can seamlessly integrate Cohere's features into serverless workflows, triggering actions based on text input, processing large volumes of data, or even enhancing chatbots with more human-like responses.

Action Code#

import app from "../../cohere_platform.app.mjs";
import { clearObj } from "../../common/utils.mjs";

export default {
  key: "cohere_platform-chat",
  name: "Chat",
  version: "0.0.1",
  description: "Generates a text response to a user message. [See the documentation](https://docs.cohere.com/reference/chat)",
  type: "action",
  props: {
    app,
    message: {
      propDefinition: [
        app,
        "message",
      ],
    },
    model: {
      propDefinition: [
        app,
        "model",
      ],
    },
    temperature: {
      propDefinition: [
        app,
        "temperature",
      ],
    },
    maxTokens: {
      propDefinition: [
        app,
        "maxTokens",
      ],
    },
    k: {
      propDefinition: [
        app,
        "k",
      ],
    },
    p: {
      propDefinition: [
        app,
        "p",
      ],
    },
    stopSequences: {
      propDefinition: [
        app,
        "stopSequences",
      ],
    },
    frequencyPenalty: {
      propDefinition: [
        app,
        "frequencyPenalty",
      ],
    },
  },
  methods: {
    chat(data) {
      return this.app.client().chat(data);
    },
  },
  async run({ $ }) {
    const {
      chat,
      message,
      model,
      temperature,
      maxTokens,
      k,
      p,
      stopSequences,
      frequencyPenalty,

    } = this;
    const response = await chat(clearObj({
      message,
      model,
      ...(temperature && {
        temperature: parseFloat(temperature),
      }),
      maxTokens,
      k,
      ...(p && {
        p: parseFloat(p),
      }),
      stopSequences,
      ...(frequencyPenalty && {
        frequencyPenalty: parseFloat(frequencyPenalty),
      }),
    }));

    $.export("$summary", `The message was successfully responded with ID \`${response.response_id}\``);
    return response;
  },
};

Action Configuration#

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI.

Label	Prop	Type	Description
Cohere	`app`	`app`	This component uses the Cohere app.
Message	`message`	`string`	Text input for the model to respond to. Compatible Deployments: Cohere Platform, Azure, AWS Sagemaker, Private Deployments
Model	`model`	`string`	Select a value from the drop down menu:`command-r-pluscommand-rcommandcommand-nightlycommand-lightcommand-light-nightlyembed-english-v3.0embed-english-light-v3.0embed-multilingual-v3.0embed-multilingual-light-v3.0embed-english-v2.0embed-english-light-v2.0embed-multilingual-v2.0rerank-english-v3.0rerank-multilingual-v3.0rerank-english-v2.0rerank-multilingual-v2.0`
Temperature	`temperature`	`string`	Must be between 0 and 1.0 inclusive that tunes the degree of randomness in generation. Lower temperatures mean less random generations, and higher temperatures mean more random generations. Randomness can be further maximized by increasing the value of the P parameter. Compatible Deployments: Cohere Platform, Azure, AWS Sagemaker, Private Deployments See Temperature for more details.
Max Tokens	`maxTokens`	`integer`	The maximum number of tokens the model will generate as part of the response. Note: Setting a low value may result in incomplete generations. Compatible Deployments: Cohere Platform, Azure, AWS Sagemaker, Private Deployments. See BPE Tokens for more details.
K	`k`	`integer`	Ensures only the top K most likely tokens are considered for generation at each step. Defaults to `0`, min value of `0`, max value of `500`. Compatible Deployments: Cohere Platform, Azure, AWS Sagemaker, Private Deployments
P	`p`	`string`	Ensures that only the most likely tokens, with total probability mass of P, are considered for generation at each step. If both K and P are enabled, P acts after K. Defaults to `0.75`. min value of `0.01`, max value of `0.99`. Compatible Deployments: Cohere Platform, Azure, AWS Sagemaker, Private Deployments
Stop Sequences	`stopSequences`	`string[]`	A list of up to 5 strings that the model will use to stop generation. If the model generates a string that matches any of the strings in the list, it will stop generating tokens and return the generated text up to that point not including the stop sequence. Compatible Deployments: Cohere Platform, Azure, AWS Sagemaker, Private Deployments
Frequency Penalty	`frequencyPenalty`	`string`	Defaults to `0.0`, min value of `0.0`, max value of `1.0`. Used to reduce repetitiveness of generated tokens. The higher the value, the stronger a penalty is applied to previously present tokens, proportional to how many times they have already appeared in the prompt or prior generation. Compatible Deployments: Cohere Platform, Azure, AWS Sagemaker, Private Deployments

Action Authentication#

Cohere uses API keys for authentication. When you connect your Cohere account, Pipedream securely stores the keys so you can easily authenticate to Cohere APIs in both code and no-code steps.

Generate and copy your API key from your Cohere Platform dashboard.

About Cohere#

Making NLP part of every developer's toolkit. Harness the power of language understanding. Join the developers and businesses who are using Cohere to generate, categorize and organize text at a scale that was previously unimaginable.