Create Contact with Agiliron API on Monthly Schedule from Schedule API

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

Trigger workflow on

Monthly Schedule from the Schedule API

Next, do this

Create Contact with the Agiliron 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 Agiliron 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 Contact action
1. Connect your Agiliron account
2. Optional- Select a Salutation
3. Configure Last Name
4. Optional- Configure First Name
5. Optional- Configure Office Phone
6. Optional- Configure Mobile
7. Optional- Configure Home Phone
8. Optional- Configure Other Phone
9. Optional- Configure Fax
10. Optional- Configure Account Name
11. Optional- Configure Account ID
12. Optional- Configure Vendor Name
13. Optional- Configure Vendor ID
14. Optional- Select a Contact Type
15. Optional- Configure Title
16. Optional- Configure Department
17. Optional- Configure Email
18. Optional- Configure Yahoo ID
19. Optional- Select a Email Opt Out
20. Optional- Select a Assigned To
21. Optional- Select a Lead Source
22. Optional- Configure Birthday
23. Optional- Configure Mailing Street
24. Optional- Configure Mailing City
25. Optional- Configure Mailing State
26. Optional- Configure Mailing Zip
27. Optional- Configure Mailing Country
28. Optional- Configure Other Street
29. Optional- Configure Other City
30. Optional- Configure Other State
31. Optional- Configure Other Zip
32. Optional- Configure Other Country
33. Optional- Configure Description
34. 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 Contact on Agiliron

Description:Generates a new contact within Agiliron. [See the documentation](https://api.agiliron.com/docs/add-contact-1)

Version:0.0.1

Key:agiliron-create-contact

View on GitHub

Action Code#

import agiliron from "../../agiliron.app.mjs";
import { parseObject } from "../../common/utils.mjs";

export default {
  key: "agiliron-create-contact",
  name: "Create Contact",
  description: "Generates a new contact within Agiliron. [See the documentation](https://api.agiliron.com/docs/add-contact-1)",
  version: "0.0.1",
  type: "action",
  props: {
    agiliron,
    salutation: {
      propDefinition: [
        agiliron,
        "salutation",
      ],
      optional: true,
    },
    lastname: {
      propDefinition: [
        agiliron,
        "lastname",
      ],
      description: "The last name of the contact.",
    },
    firstName: {
      propDefinition: [
        agiliron,
        "firstName",
      ],
      description: "The first name of the contact",
      optional: true,
    },
    officePhone: {
      type: "string",
      label: "Office Phone",
      description: "The office phone number of the contact",
      optional: true,
    },
    mobile: {
      propDefinition: [
        agiliron,
        "mobile",
      ],
      description: "The mobile number of the contact",
      optional: true,
    },
    homePhone: {
      type: "string",
      label: "Home Phone",
      description: "The home phone number of the contact",
      optional: true,
    },
    otherPhone: {
      type: "string",
      label: "Other Phone",
      description: "An additional phone number of the contact",
      optional: true,
    },
    fax: {
      propDefinition: [
        agiliron,
        "fax",
      ],
      description: "The fax number of the contact",
      optional: true,
    },
    accountName: {
      type: "string",
      label: "Account Name",
      description: "The account name of the contact",
      optional: true,
    },
    accountId: {
      type: "string",
      label: "Account ID",
      description: "The account id of the contact",
      optional: true,
    },
    vendorName: {
      type: "string",
      label: "Vendor Name",
      description: "The vendor name of the contact",
      optional: true,
    },
    vendorId: {
      type: "string",
      label: "Vendor ID",
      description: "The vendor id of the contact",
      optional: true,
    },
    contactType: {
      propDefinition: [
        agiliron,
        "contactType",
      ],
      description: "The contact type of the contact",
      optional: true,
    },
    title: {
      type: "string",
      label: "Title",
      description: "The title of the contact.",
      optional: true,
    },
    department: {
      type: "string",
      label: "Department",
      description: "The department of the contact.",
      optional: true,
    },
    email: {
      propDefinition: [
        agiliron,
        "email",
      ],
      description: "The email address of the contact",
      optional: true,
    },
    yahooId: {
      propDefinition: [
        agiliron,
        "yahooId",
      ],
      description: "The Yahoo ID of the contact",
      optional: true,
    },
    emailOptOut: {
      propDefinition: [
        agiliron,
        "emailOptOut",
      ],
      description: "The email opt-out status of the contact",
      optional: true,
    },
    assignedTo: {
      propDefinition: [
        agiliron,
        "assignedTo",
      ],
      description: "The user to whom the contact is assigned",
      optional: true,
    },
    leadSource: {
      propDefinition: [
        agiliron,
        "leadSource",
      ],
      description: "The lead source of the contact",
      optional: true,
    },
    birthday: {
      type: "string",
      label: "Birthday",
      description: "The birthday of the contact.",
      optional: true,
    },
    mailingStreet: {
      type: "string",
      label: "Mailing Street",
      description: "The mailing street address of the contact",
      optional: true,
    },
    mailingCity: {
      type: "string",
      label: "Mailing City",
      description: "The mailing city of the contact",
      optional: true,
    },
    mailingState: {
      type: "string",
      label: "Mailing State",
      description: "The mailing state of the contact",
      optional: true,
    },
    mailingZip: {
      type: "string",
      label: "Mailing Zip",
      description: "The mailing zip code of the contact",
      optional: true,
    },
    mailingCountry: {
      type: "string",
      label: "Mailing Country",
      description: "The mailing country of the contact",
      optional: true,
    },
    otherStreet: {
      type: "string",
      label: "Other Street",
      description: "The other street address of the contact",
      optional: true,
    },
    otherCity: {
      type: "string",
      label: "Other City",
      description: "The other city of the contact",
      optional: true,
    },
    otherState: {
      type: "string",
      label: "Other State",
      description: "The other state of the contact",
      optional: true,
    },
    otherZip: {
      type: "string",
      label: "Other Zip",
      description: "The other zip code of the contact",
      optional: true,
    },
    otherCountry: {
      type: "string",
      label: "Other Country",
      description: "The other country of the contact",
      optional: true,
    },
    description: {
      propDefinition: [
        agiliron,
        "description",
      ],
      description: "The description of the contact",
      optional: true,
    },
    customFields: {
      propDefinition: [
        agiliron,
        "customFields",
      ],
      description: "An object of custom fields for the contact. **Format: {customFieldName01: \"Value 01\"}**",
      optional: true,
    },
  },
  async run({ $ }) {
    const parsedCustomFields = parseObject(this.customFields);
    const customFields = parsedCustomFields && Object.keys(parsedCustomFields).map((key) => ({
      Name: key,
      value: parsedCustomFields[key],
    }));
    const contact = {
      Salutation: this.salutation,
      LastName: this.lastname,
      FirstName: this.firstName,
      OfficePhone: this.officePhone,
      Mobile: this.mobile,
      HomePhone: this.homePhone,
      OtherPhone: this.otherPhone,
      Fax: this.fax,
      AccountName: this.accountName,
      AccountID: this.accountId,
      VendorName: this.vendorName,
      VendorID: this.vendorId,
      ContactType: this.contactType,
      Title: this.title,
      Department: this.department,
      Email: this.email,
      YahooID: this.yahooId,
      EmailOptOut: this.emailOptOut,
      AssignedTo: this.assignedTo,
      LeadSource: this.leadSource,
      Birthday: this.birthday,
      MailingStreet: this.mailingStreet,
      MailingCity: this.mailingCity,
      MailingState: this.mailingState,
      MailingZip: this.mailingZip,
      MailingCountry: this.mailingCountry,
      OtherStreet: this.otherStreet,
      OtherCity: this.otherCity,
      OtherState: this.otherState,
      OtherZip: this.otherZip,
      OtherCountry: this.otherCountry,
      Description: this.description,
      CustomFields: {
        CustomField: customFields,
      },
    };

    const response = await this.agiliron.addContact({
      $,
      data: {
        "Contacts": {
          "Contact": contact,
        },
      },
    });

    $.export("$summary", `Successfully created contact with Id: ${response?.MCM?.parameters?.results?.message?.success_message?.contact_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
Agiliron	`agiliron`	`app`	This component uses the Agiliron app.
Salutation	`salutation`	`string`	Select a value from the drop down menu:`--None--Mr.Ms.Mrs.Dr.Prof.`
Last Name	`lastname`	`string`	The last name of the contact.
First Name	`firstName`	`string`	The first name of the contact
Office Phone	`officePhone`	`string`	The office phone number of the contact
Mobile	`mobile`	`string`	The mobile number of the contact
Home Phone	`homePhone`	`string`	The home phone number of the contact
Other Phone	`otherPhone`	`string`	An additional phone number of the contact
Fax	`fax`	`string`	The fax number of the contact
Account Name	`accountName`	`string`	The account name of the contact
Account ID	`accountId`	`string`	The account id of the contact
Vendor Name	`vendorName`	`string`	The vendor name of the contact
Vendor ID	`vendorId`	`string`	The vendor id of the contact
Contact Type	`contactType`	`string`	Select a value from the drop down menu:`--None--AnalystCompetitorCustomerIntegratorInvestorPartnerPressProspectResellerOtherMediaSuppliersCustomers`
Title	`title`	`string`	The title of the contact.
Department	`department`	`string`	The department of the contact.
Email	`email`	`string`	The email address of the contact
Yahoo ID	`yahooId`	`string`	The Yahoo ID of the contact
Email Opt Out	`emailOptOut`	`string`	Select a value from the drop down menu:`YesNo`
Assigned To	`assignedTo`	`string`	Select a value from the drop down menu:`adminposuser`
Lead Source	`leadSource`	`string`	Select a value from the drop down menu:`--None--Cold CallExisting CustomerSelf GeneratedEmployeePartnerPublic RelationsDirect MailConferenceTrade ShowWeb SiteWord of mouthOther`
Birthday	`birthday`	`string`	The birthday of the contact.
Mailing Street	`mailingStreet`	`string`	The mailing street address of the contact
Mailing City	`mailingCity`	`string`	The mailing city of the contact
Mailing State	`mailingState`	`string`	The mailing state of the contact
Mailing Zip	`mailingZip`	`string`	The mailing zip code of the contact
Mailing Country	`mailingCountry`	`string`	The mailing country of the contact
Other Street	`otherStreet`	`string`	The other street address of the contact
Other City	`otherCity`	`string`	The other city of the contact
Other State	`otherState`	`string`	The other state of the contact
Other Zip	`otherZip`	`string`	The other zip code of the contact
Other Country	`otherCountry`	`string`	The other country of the contact
Description	`description`	`string`	The description of the contact
Custom Fields	`customFields`	`object`	An object of custom fields for the contact. Format: {customFieldName01: "Value 01"}