Create Person with Agendor API on New Scheduled Tasks from Pipedream API

Pipedream makes it easy to connect APIs for Agendor, Pipedream and 2,900+ other apps remarkably fast.

Trigger workflow on

New Scheduled Tasks from the Pipedream API

Next, do this

Create Person with the Agendor 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 Pipedream trigger and Agendor action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Scheduled Tasks trigger
1. Connect your Pipedream account
2. Optional- Configure Secret
Configure the Create Person action
1. Connect your Agendor account
2. Configure Name
3. Optional- Configure Legal Document Number (CPF)
4. Optional- Select a Organization ID
5. Optional- Configure Role
6. Optional- Select a Ranking
7. Optional- Configure Description
8. Optional- Configure Birthday
9. Optional- Select a Owner User
10. Optional- Configure Contact
11. Optional- Configure Address
12. Optional- Select a Lead Origin
13. Optional- Select a Category
14. Optional- Select one or more Products
15. Optional- Select a Allowed Users
16. Optional- Configure Allow to All Users
17. Optional- Configure Custom Fields
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 Scheduled Tasks on Pipedream

Description:Exposes an HTTP API for scheduling messages to be emitted at a future time

Version:0.3.1

Key:pipedream-new-scheduled-tasks

View on GitHub

Pipedream Overview#

Pipedream is an API that allows you to build applications that can connect to
various data sources and processes them in real-time. You can use Pipedream to
create applications that can perform ETL (Extract, Transform, and Load) tasks,
as well as to create data-driven workflows.

Some examples of applications you can build using the Pipedream API include:

An application that can extract data from a database, transform it, and then
load it into another database.
An application that can monitor a data source for changes, and then trigger a
workflow in response to those changes.
An application that can poll an API for new data, and then process that data
in real-time.

Trigger Code#

import pipedream from "../../pipedream.app.mjs";
import sampleEmit from "./test-event.mjs";
import { uuid } from "uuidv4";

export default {
  key: "pipedream-new-scheduled-tasks",
  name: "New Scheduled Tasks",
  type: "source",
  description:
    "Exposes an HTTP API for scheduling messages to be emitted at a future time",
  version: "0.3.1",
  dedupe: "unique", // Dedupe on a UUID generated for every scheduled task
  props: {
    pipedream,
    secret: {
      type: "string",
      secret: true,
      label: "Secret",
      optional: true,
      description:
        "**Optional but recommended**: if you enter a secret here, you must pass this value in the `x-pd-secret` HTTP header when making requests",
    },
    http: {
      label: "Endpoint",
      description: "The endpoint where you'll send task scheduler requests",
      type: "$.interface.http",
      customResponse: true,
    },
    db: "$.service.db",
  },
  methods: {
    // To schedule future emits, we emit to the selfChannel of the component
    selfChannel() {
      return "self";
    },
    // Queue for future emits that haven't yet been delivered
    queuedEventsChannel() {
      return "$in";
    },
    httpRespond({
      status, body,
    }) {
      this.http.respond({
        headers: {
          "content-type": "application/json",
        },
        status,
        body,
      });
    },
    async selfSubscribe() {
      // Subscribe the component to itself. We do this here because even in
      // the activate hook, the component isn't available to take subscriptions.
      // Scheduled tasks are sent to the self channel, which emits the message at
      // the specified delivery_ts to this component.
      const isSubscribedToSelf = this.db.get("isSubscribedToSelf");
      if (!isSubscribedToSelf) {
        const componentId = process.env.PD_COMPONENT;
        const selfChannel = this.selfChannel();
        console.log(`Subscribing to ${selfChannel} channel for event source`);
        console.log(
          await this.pipedream.subscribe(componentId, componentId, selfChannel),
        );
        this.db.set("isSubscribedToSelf", true);
      }
    },
    validateEventBody(event, operation) {
      const errors = [];

      // Secrets are optional, so we first check if the user configured
      // a secret, then check its value against the prop (validation below)
      if (this.secret && event.headers["x-pd-secret"] !== this.secret) {
        errors.push(
          "Secret on incoming request doesn't match the configured secret",
        );
      }

      if (operation === "schedule") {
        const {
          timestamp,
          message,
        } = event.body;
        // timestamp should be an ISO 8601 string. Parse and check for validity below.
        const epoch = Date.parse(timestamp);

        if (!timestamp) {
          errors.push(
            "No timestamp included in payload. Please provide an ISO8601 timestamp in the 'timestamp' field",
          );
        }
        if (timestamp && !epoch) {
          errors.push("Timestamp isn't a valid ISO 8601 string");
        }
        if (!message) {
          errors.push("No message passed in payload");
        }
      }

      return errors;
    },
    scheduleTask(event) {
      const errors = this.validateEventBody(event, "schedule");
      let status, body;

      if (errors.length) {
        console.log(errors);
        status = 400;
        body = {
          errors,
        };
      } else {
        const id = this.emitScheduleEvent(event.body, event.body.timestamp);
        status = 200;
        body = {
          msg: "Successfully scheduled task",
          id,
        };
      }

      this.httpRespond({
        status,
        body,
      });
    },
    emitScheduleEvent(event, timestamp) {
      const selfChannel = this.selfChannel();
      const epoch = Date.parse(timestamp);
      const $id = uuid();

      console.log(`Scheduled event to emit on: ${new Date(epoch)}`);

      this.$emit(
        {
          ...event,
          $channel: selfChannel,
          $id,
        },
        {
          name: selfChannel,
          id: $id,
          delivery_ts: epoch,
        },
      );

      return $id;
    },
    async cancelTask(event) {
      const errors = this.validateEventBody(event, "cancel");
      let status, msg;

      if (errors.length) {
        console.log(errors);
        status = 400;
        msg = "Secret on incoming request doesn't match the configured secret";
      } else {
        try {
          const id = event.body.id;
          const isCanceled = await this.deleteEvent(event);
          if (isCanceled) {
            status = 200;
            msg = `Cancelled scheduled task for event ${id}`;
          } else {
            status = 404;
            msg = `No event with ${id} found`;
          }
        } catch (error) {
          console.log(error);
          status = 500;
          msg = "Failed to schedule task. Please see the logs";
        }
      }

      this.httpRespond({
        status,
        body: {
          msg,
        },
      });
    },
    async deleteEvent(event) {
      const componentId = process.env.PD_COMPONENT;
      const inChannel = this.queuedEventsChannel();

      // The user must pass a scheduled event UUID they'd like to cancel
      // We lookup the event by ID and delete it
      const { id } = event.body;

      // List events in the $in channel - the queue of scheduled events, to be emitted in the future
      const events = await this.pipedream.listEvents(
        componentId,
        inChannel,
      );
      console.log("Events: ", events);

      // Find the event in the list by id
      const eventToCancel = events.data.find((e) => {
        const { metadata } = e;
        return metadata.id === id;
      });

      console.log("Event to cancel: ", eventToCancel);

      if (!eventToCancel) {
        console.log(`No event with ${id} found`);
        return false;
      }

      // Delete the event
      await this.pipedream.deleteEvent(
        componentId,
        eventToCancel.id,
        inChannel,
      );
      return true;
    },
    emitEvent(event, summary) {
      // Delete the channel name and id from the incoming event, which were used only as metadata
      const id = event.$id;
      delete event.$channel;
      delete event.$id;

      this.$emit(event, {
        summary: summary ?? JSON.stringify(event),
        id,
        ts: +new Date(),
      });
    },
  },
  async run(event) {
    await this.selfSubscribe();

    const { path } = event;
    if (path === "/schedule") {
      this.scheduleTask(event);
    } else if (path === "/cancel") {
      await this.cancelTask(event);
    } else if (event.$channel === this.selfChannel()) {
      this.emitEvent(event);
    }
  },
  sampleEmit,
};

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
Pipedream	`pipedream`	`app`	This component uses the Pipedream app.
Secret	`secret`	`string`	Optional but recommended: if you enter a secret here, you must pass this value in the `x-pd-secret` HTTP header when making requests
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.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.

Trigger Authentication#

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

About Pipedream#

Integration platform for developers

Action#

Create Person on Agendor

Description:Create Person [See the documentation](https://api.agendor.com.br/docs/#operation/Create%20person).

Version:0.0.2

Key:agendor-create-person

View on GitHub

Agendor Overview#

The Agendor API allows for seamless integration with a CRM platform, enabling automation of sales processes, data synchronization, and enhanced analytics. By leveraging the Agendor API on Pipedream, you can orchestrate workflows that react to events in Agendor, manipulate and analyze sales data, and bridge your sales processes with other tools like email marketing services, customer support platforms, and cloud storage solutions.

Action Code#

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

export default {
  name: "Create Person",
  description: "Create Person [See the documentation](https://api.agendor.com.br/docs/#operation/Create%20person).",
  key: "agendor-create-person",
  version: "0.0.2",
  annotations: {
    destructiveHint: false,
    openWorldHint: true,
    readOnlyHint: false,
  },
  type: "action",
  props: {
    app,
    name: {
      type: "string",
      label: "Name",
      description: "Name of this person.",
    },
    cpf: {
      type: "string",
      label: "Legal Document Number (CPF)",
      description: "Legal document number (CPF)",
      optional: true,
    },
    organizationId: {
      propDefinition: [
        app,
        "organizationId",
      ],
      optional: true,
    },
    role: {
      type: "string",
      label: "Role",
      description: "Person's role in their organization",
      optional: true,
    },
    ranking: {
      propDefinition: [
        app,
        "ranking",
      ],
    },
    description: {
      propDefinition: [
        app,
        "description",
      ],
      description: "Your description of this person.",
    },
    birthday: {
      type: "string",
      label: "Birthday",
      description: "Person's birthday with or without year (`YYYY-MM-DD` or `MM-DD`).",
      optional: true,
    },
    ownerUser: {
      propDefinition: [
        app,
        "userId",
      ],
      description: "User ID or email of the owner of this person.",
    },
    contact: {
      propDefinition: [
        app,
        "contact",
      ],
    },
    address: {
      propDefinition: [
        app,
        "address",
      ],
    },
    leadOrigin: {
      propDefinition: [
        app,
        "leadOrigin",
      ],
    },
    category: {
      propDefinition: [
        app,
        "category",
      ],
    },
    products: {
      propDefinition: [
        app,
        "product",
      ],
      type: "string[]",
      label: "Products",
    },
    allowedUsers: {
      propDefinition: [
        app,
        "userId",
      ],
      label: "Allowed Users",
      description: "Array of IDs of users that should be able to see this person.",
    },
    allowToAllUsers: {
      propDefinition: [
        app,
        "allowToAllUsers",
      ],
      description: "Set true if this person should be visible to all users.",
    },
    customFields: {
      propDefinition: [
        app,
        "customFields",
      ],
    },
  },
  async run({ $ }) {
    const {
      app,
      ...data
    } = this;
    const person = await app.createPerson(data);
    $.export("summary", `Person successfully created with id "${person.data.id}".`);
    return person;
  },
};

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
Agendor	`app`	`app`	This component uses the Agendor app.
Name	`name`	`string`	Name of this person.
Legal Document Number (CPF)	`cpf`	`string`	Legal document number (CPF)
Organization ID	`organizationId`	`string`	Select a value from the drop down menu.
Role	`role`	`string`	Person's role in their organization
Ranking	`ranking`	`string`	Select a value from the drop down menu:`012345`
Description	`description`	`string`	Your description of this person.
Birthday	`birthday`	`string`	Person's birthday with or without year (`YYYY-MM-DD` or `MM-DD`).
Owner User	`ownerUser`	`string`	Select a value from the drop down menu.
Contact	`contact`	`object`	Contact object can have the following properties: `email, work, mobile, fax, whatsapp, facbeook, twitter, instagram, linked_in, skype`. Please check the documentation in the description for more information.
Address	`address`	`object`	Address Object can have the following properties: `postal_code, country, district, state, street_name, street_number, additional_info, city`. Please check the documentation in the description for more information.
Lead Origin	`leadOrigin`	`string`	Select a value from the drop down menu.
Category	`category`	`string`	Select a value from the drop down menu.
Products	`products`	`string[]`	Select a value from the drop down menu.
Allowed Users	`allowedUsers`	`string`	Select a value from the drop down menu.
Allow to All Users	`allowToAllUsers`	`boolean`	Set true if this person should be visible to all users.
Custom Fields	`customFields`	`object`	Custom fields information.

Action Authentication#

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

To retrieve your API Token,

Navigate to your Agendor account and sign in
Go to “Menu” > “Integrations”

Try it

Find Organization with Agendor API on New Scheduled Tasks from Pipedream API

Pipedream + Agendor

Try it

Find Person with Agendor API on New Scheduled Tasks from Pipedream API

Pipedream + Agendor

Try it

Popular Triggers#

New Scheduled Tasks from the Pipedream API

Exposes an HTTP API for scheduling messages to be emitted at a future time

Try it

Card Due Date Reminder from the Pipedream API

Emit new event at a specified time before a card is due.

Try it

New Upcoming Calendar Event from the Pipedream API

Emit new event when a Calendar event is upcoming, this source is using reminderMinutesBeforeStart property of the event to determine the time it should emit.

Try it