Create Post with Circle API on New Outbound Message (Instant) from Salesforce API

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

Trigger workflow on

New Outbound Message (Instant) from the Salesforce API

Next, do this

Create Post with the Circle 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 Circle 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 Create Post action
1. Connect your Circle account
2. Select a Community ID
3. Select a Space ID
4. Optional- Select a Status
5. Optional- Configure Published At
6. Configure Name
7. Configure Body
8. Configure Is Pinned
9. Configure Is Comments Enabled
10. Configure Is Comments Closed
11. Optional- Configure Is Liking Enabled
12. Optional- Select a User Email
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#

Create Post on Circle

Description:Create a new post in a selected space within your Circle community. [See the documentation](https://api.circle.so/#ffc804e8-02a8-48dc-a5c8-dc278f909fa4)

Version:0.0.1

Key:circle-create-post

View on GitHub

Circle Overview#

The Circle API enables developers to tap into the heart of their Circle community platform, allowing them to read and write various types of community data programmatically. With this API, you can automate community management tasks, extract insights, manage members, and create a more dynamic and integrated community experience. By leveraging the Circle API within Pipedream's ecosystem, you can stitch together powerful workflows that react to events in Circle, push data to other services, and streamline community operations.

Action Code#

import circle from "../../circle.app.mjs";

export default {
  key: "circle-create-post",
  name: "Create Post",
  description: "Create a new post in a selected space within your Circle community. [See the documentation](https://api.circle.so/#ffc804e8-02a8-48dc-a5c8-dc278f909fa4)",
  version: "0.0.1",
  type: "action",
  props: {
    circle,
    communityId: {
      propDefinition: [
        circle,
        "communityId",
      ],
    },
    spaceId: {
      propDefinition: [
        circle,
        "spaceId",
        ({ communityId }) => ({
          communityId,
        }),
      ],
    },
    status: {
      type: "string",
      label: "Status",
      description: "The post's status. **Default is published**",
      options: [
        "published",
        "draft",
        "scheduled",
      ],
      optional: true,
    },
    publishedAt: {
      type: "string",
      label: "Published At",
      description: "Acts as the publish time and is required when **status** is `scheduled`. Must be in the past when **status** is `published`. `Format: YYYY-MM-DDTHH:MM:SS.SSSZ`",
      optional: true,
    },
    name: {
      type: "string",
      label: "Name",
      description: "The name of the post",
    },
    body: {
      propDefinition: [
        circle,
        "body",
      ],
    },
    isPinned: {
      type: "boolean",
      label: "Is Pinned",
      description: "Whether the post is pinned to the top or not.",
      default: true,
    },
    isCommentsEnabled: {
      type: "boolean",
      label: "Is Comments Enabled",
      description: "Whether comments are shown or not.",
      default: true,
    },
    isCommentsClosed: {
      type: "boolean",
      label: "Is Comments Closed",
      description: "Whether users can comment or not.",
      default: false,
    },
    isLikingEnabled: {
      type: "boolean",
      label: "Is Liking Enabled",
      description: "Whether links are enabled or not.",
      optional: true,
    },
    userEmail: {
      propDefinition: [
        circle,
        "userEmail",
      ],
      optional: true,
    },
  },
  async run({ $ }) {
    const response = await this.circle.createPost({
      params: {
        community_id: this.communityId,
        space_id: this.spaceId,
        status: this.status,
        published_at: this.publishedAt,
        name: this.name,
        body: this.body,
        is_pinned: this.isPinned,
        is_comments_enabled: this.isCommentsEnabled,
        is_comments_closed: this.isCommentsClosed,
        is_liking_enabled: this.isLikingEnabled,
        user_email: this.userEmail,
      },
    });

    if (!response.success) {
      throw new Error(response.errors || response.message);
    }

    $.export("$summary", `Successfully created post with ID: ${response.post?.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
Circle	`circle`	`app`	This component uses the Circle app.
Community ID	`communityId`	`string`	Select a value from the drop down menu.
Space ID	`spaceId`	`string`	Select a value from the drop down menu.
Status	`status`	`string`	Select a value from the drop down menu:`publisheddraftscheduled`
Published At	`publishedAt`	`string`	Acts as the publish time and is required when status is `scheduled`. Must be in the past when status is `published`. `Format: YYYY-MM-DDTHH:MM:SS.SSSZ`
Name	`name`	`string`	The name of the post
Body	`body`	`string`	The body of the post.
Is Pinned	`isPinned`	`boolean`	Whether the post is pinned to the top or not.
Is Comments Enabled	`isCommentsEnabled`	`boolean`	Whether comments are shown or not.
Is Comments Closed	`isCommentsClosed`	`boolean`	Whether users can comment or not.
Is Liking Enabled	`isLikingEnabled`	`boolean`	Whether links are enabled or not.
User Email	`userEmail`	`string`	Select a value from the drop down menu.

Action Authentication#

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

To retrieve your API keys,

Navigate to your Circle account and sign in
Go to “Settings” > “Account” > “API”

About Circle#

The all-in-one community platform for creators and brands.

More Ways to Connect Circle + Salesforce#

Other Popular Integrations#

Create Comment with Circle API on New Outbound Message (Instant) from Salesforce (REST API) API

Salesforce + Circle

Create Post with Circle API on New Outbound Message (Instant) from Salesforce API

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

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

Developers ♥ Pipedream

1-24of2,400+apps by most popular

1
-
24
of
2,400+
apps by most popular