Create Person with Agendor API on Monthly Schedule from Schedule API

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

Trigger workflow on

Monthly Schedule from the Schedule 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 Schedule 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 Monthly Schedule trigger
1. Connect your Schedule account
2. Configure Cron Schedule
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#

Monthly Schedule on Schedule

Description:Trigger your workflow on one or more days each month at a specific time (with timezone support).

Version:0.0.2

Key:schedule-monthly

View on GitHub

Schedule Overview#

The Schedule app in Pipedream is a powerful tool that allows you to trigger workflows at regular intervals, ranging from every minute to once a year. This enables the automation of repetitive tasks and the scheduling of actions to occur without manual intervention. By leveraging this API, you can execute code, run integrations, and process data on a reliable schedule, all within Pipedream's serverless environment.

Trigger Code#

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

export default {
  name: "Monthly Schedule",
  version: "0.0.2",
  key: "schedule-monthly",
  type: "source",
  description: "Trigger your workflow on one or more days each month at a specific time (with timezone support).",
  props: {
    schedule,
    cron: {
      propDefinition: [
        schedule,
        "cron",
      ],
      default: {
        cron: "0 10 1 * *",
      },
    },
  },
};

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
Schedule	`schedule`	`app`	This component uses the Schedule app.
Cron Schedule	`cron`	`$.interface.timer`	Enter a cron expression

Trigger Authentication#

The Schedule API does not require authentication.

About Schedule#

Trigger workflows on an interval or cron schedule.

Action#

Create Person on Agendor

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

Version:0.0.1

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.1",
  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,