Create Appointment Task with Tookan API on New Outbound Message (Instant) from Salesforce API

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

Trigger workflow on

New Outbound Message (Instant) from the Salesforce API

Next, do this

Create Appointment Task with the Tookan 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 Tookan 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 Appointment Task action
1. Connect your Tookan account
2. Optional- Configure Additional Options
3. Select a Time Zone
4. Configure Customer Address
5. Configure Job Delivery Date/Time
6. Configure Job Pickup Date/Time
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 Appointment Task on Tookan

Description:Create an appointment task [See docs here](https://tookanapi.docs.apiary.io/#reference/task/create-task/create-an-appointment-task)

Version:0.0.1

Key:tookan-create-appointment-task

View on GitHub

Tookan Overview#

The Tookan API allows for the automation and streamlining of delivery and field services. By integrating with Pipedream, users can trigger workflows based on events within Tookan, such as new task creation, task status updates, or agent alerts. This enables businesses to connect Tookan with other apps and services, automating notifications, data synchronization, and logistics operations, leading to improved coordination, customer satisfaction, and operational efficiency.

Action Code#

import { defineAction } from "@pipedream/types";
import tookan from "../../app/tookan.app.mjs";
import common from "../common.mjs";
export default defineAction({
    ...common,
    name: "Create Appointment Task",
    description: "Create an appointment task [See docs here](https://tookanapi.docs.apiary.io/#reference/task/create-task/create-an-appointment-task)",
    key: "tookan-create-appointment-task",
    version: "0.0.1",
    type: "action",
    props: {
        ...common.props,
        customerAddress: {
            propDefinition: [
                tookan,
                "customerAddress",
            ],
        },
        jobDeliveryDatetime: {
            propDefinition: [
                tookan,
                "jobDeliveryDatetime",
            ],
        },
        jobPickupDatetime: {
            propDefinition: [
                tookan,
                "jobPickupDatetime",
            ],
        },
    },
    async run({ $ }) {
        const params = {
            $,
            data: {
                timezone: this.timezone,
                customer_address: this.customerAddress,
                job_delivery_datetime: this.jobDeliveryDatetime,
                job_pickup_datetime: this.jobPickupDatetime,
                has_delivery: 0,
                has_pickup: 0,
                layout_type: 1,
                ...this.additionalOptions,
            },
        };
        const data = await this.tookan.createAppointmentTask(params);
        $.export("$summary", `Created appointment task successfully (id ${data.job_id})`);
        return data;
    },
});

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
Tookan	`tookan`	`app`	This component uses the Tookan app.
Additional Options	`additionalOptions`	`object`	Any optional parameters to pass to the request (see the Tookan API docs for available parameters)
Time Zone	`timezone`	`string`	Select a value from the drop down menu:`{ "label": "UTC -8 (PST)", "value": "-480" }{ "label": "UTC -7 (MST)", "value": "-420" }{ "label": "UTC -6 (CST)", "value": "-360" }{ "label": "UTC -5 (EST)", "value": "-300" }{ "label": "UTC -4 (AST)", "value": "-240" }{ "label": "UTC -3 (BRT)", "value": "-180" }{ "label": "UTC -2", "value": "-120" }{ "label": "UTC -1", "value": "-60" }{ "label": "UTC 0 (GMT)", "value": "0" }{ "label": "UTC +1 (CET)", "value": "+60" }{ "label": "UTC +2 (EET)", "value": "+120" }{ "label": "UTC +3 (MSK)", "value": "+180" }{ "label": "UTC +4", "value": "+240" }`
Customer Address	`customerAddress`	`string`	This is the address of the customer to whom the product should be delivered
Job Delivery Date/Time	`jobDeliveryDatetime`	`string`	This is the time before which the product should be delivered. Use a date/time string in the format `2016-08-14 19:00:00`
Job Pickup Date/Time	`jobPickupDatetime`	`string`	This is time before which the pickup should be collected. Use a date/time string in the format `2016-08-14 19:00:00`

Action Authentication#

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

To retrieve your API key,
Navigate to your Tookan account and sign in
Go to “Settings” > “API Keys”