Verify Address with Xverify API on Weekly schedule from Schedule API

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

Trigger workflow on

Weekly schedule from the Schedule API

Next, do this

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

Select this integration
Configure the Weekly schedule trigger
1. Connect your Schedule account
2. Configure Cron Schedule
Configure the Verify Address action
1. Connect your Xverify account
2. Configure info
3. Select a Domain
4. Configure Street Address 1
5. Optional- Configure Street Address 2
6. Optional- Configure City
7. Optional- Configure State
8. Optional- Configure Zip Code
9. Optional- Configure Urbanization
10. Optional- Configure Parse Address
11. Optional- Configure Affiliate ID
12. Optional- Configure Sub-Affiliate ID
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#

Weekly schedule on Schedule

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

Version:0.0.1

Key:schedule-weekly

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: "Weekly schedule",
  version: "0.0.1",
  key: "schedule-weekly",
  type: "source",
  description: "Trigger your workflow on one or more days each week 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#

Verify Address on Xverify

Description:Sends an address verification request. [See the documentation](https://apidocs.xverify.com/#address-verification-api-endpoint).

Version:0.0.1

Key:xverify-verify-address

View on GitHub

Action Code#

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

export default {
  key: "xverify-verify-address",
  name: "Verify Address",
  description: "Sends an address verification request. [See the documentation](https://apidocs.xverify.com/#address-verification-api-endpoint).",
  version: "0.0.1",
  type: "action",
  props: {
    app,
    // eslint-disable-next-line pipedream/props-label, pipedream/props-description
    info: {
      type: "alert",
      alertType: "info",
      content: "**Note**: The `city`, `state`, and `zip` fields are optional. However, you must provide at least one of these fields to verify an address. If you provide all three fields, the API will use the city and state to verify the address.",
    },
    domain: {
      propDefinition: [
        app,
        "domain",
      ],
    },
    address1: {
      type: "string",
      label: "Street Address 1",
      description: "The street address to be verified.",
    },
    address2: {
      type: "string",
      label: "Street Address 2",
      description: "The second line of the street address to be verified.",
      optional: true,
    },
    city: {
      type: "string",
      label: "City",
      description: "The city of the address to be verified.",
      optional: true,
    },
    state: {
      type: "string",
      label: "State",
      description: "The state of the address to be verified.",
      optional: true,
    },
    zip: {
      type: "string",
      label: "Zip Code",
      description: "The postal code of the address to be verified. **Required** if city and state are not provided.",
      optional: true,
    },
    urbanization: {
      type: "string",
      label: "Urbanization",
      description: "A component of certain addresses in Puerto Rico.",
      optional: true,
    },
    parse: {
      type: "boolean",
      label: "Parse Address",
      description: "Set to `true` if you want the street address to be parsed into individual elements in the response.",
      optional: true,
    },
    aff: {
      propDefinition: [
        app,
        "aff",
      ],
    },
    subaff: {
      propDefinition: [
        app,
        "subaff",
      ],
    },
  },
  methods: {
    verifyAddress(args = {}) {
      return this.app._makeRequest({
        path: "/av",
        ...args,
      });
    },
  },
  async run({ $ }) {
    const {
      verifyAddress,
      domain,
      address1,
      address2,
      city,
      state,
      zip,
      urbanization,
      parse,
      aff,
      subaff,
    } = this;

    const response = await verifyAddress({
      $,
      params: {
        domain,
        address1,
        address2,
        city,
        state,
        zip,
        urbanization,
        parse,
        aff,
        subaff,
      },
    });

    $.export("$summary", `Successfully sent address verification request with status \`${response.status}\`.`);
    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
Xverify	`app`	`app`	This component uses the Xverify app.
Domain	`domain`	`string`	Select a value from the drop down menu.
Street Address 1	`address1`	`string`	The street address to be verified.
Street Address 2	`address2`	`string`	The second line of the street address to be verified.
City	`city`	`string`	The city of the address to be verified.
State	`state`	`string`	The state of the address to be verified.
Zip Code	`zip`	`string`	The postal code of the address to be verified. Required if city and state are not provided.
Urbanization	`urbanization`	`string`	A component of certain addresses in Puerto Rico.
Parse Address	`parse`	`boolean`	Set to `true` if you want the street address to be parsed into individual elements in the response.
Affiliate ID	`aff`	`string`	The ID you define to identify the affiliate or source of the email for reporting or potential blocking.
Sub-Affiliate ID	`subaff`	`string`	The sub-identifier you define for the affiliate or source of the email for reporting or potential blocking.