Check for existence of key with Data Stores API on New Check-In Created from Badger Maps API

Pipedream makes it easy to connect APIs for Data Stores, Badger Maps and 2,900+ other apps remarkably fast.

Trigger workflow on

New Check-In Created from the Badger Maps API

Next, do this

Check for existence of key with the Data Stores 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 Badger Maps trigger and Data Stores action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Check-In Created trigger
1. Connect your Badger Maps account
2. Configure Polling schedule
3. Select a Account ID
Configure the Check for existence of key action
1. Connect your Data Stores account
2. Configure Data Store
3. Select a Key
4. Optional- Select a Create a new record if the key is not found?
5. Optional- Configure Time to Live (TTL)
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 Check-In Created on Badger Maps

Description:Emit new event each time a new check-in is created.

Version:0.0.1

Key:badger_maps-new-check-in-created

View on GitHub

Badger Maps Overview#

The Badger Maps API offers interaction with a platform designed for field sales; it allows you to optimize routes, manage territories, and explore customer locations. Combining the Badger Maps API with Pipedream's capabilities enables the automation of sales processes, integration with CRM systems, and enhancement of data analytics. You can build workflows that respond to events in real-time, sync data across multiple platforms, and create custom triggers and actions that cater specifically to your sales strategies.

Trigger Code#

import common from "../common/polling.mjs";

export default {
  ...common,
  key: "badger_maps-new-check-in-created",
  name: "New Check-In Created",
  description: "Emit new event each time a new check-in is created.",
  type: "source",
  version: "0.0.1",
  dedupe: "unique",
  props: {
    ...common.props,
    accountId: {
      propDefinition: [
        common.props.app,
        "accountId",
      ],
    },
  },
  methods: {
    ...common.methods,
    getResourceFn() {
      return this.app.listCheckIns;
    },
    getResourceFnArgs() {
      return {
        params: {
          customer_id: this.accountId,
        },
      };
    },
    generateMeta(resource) {
      return {
        id: resource.id,
        summary: `New check-in ${resource.id}`,
        ts: Date.parse(resource.log_datetime),
      };
    },
  },
};

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
Badger Maps	`app`	`app`	This component uses the Badger Maps app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
Polling schedule	`timer`	`$.interface.timer`	How often to poll the API
Account ID	`accountId`	`string`	Select a value from the drop down menu.

Trigger Authentication#

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

To connect Pipedream to Badger Maps, first make sure you've requested API access from the Badger Maps Support team. Once they've enabled API access,

Sign in to your Badger Maps account
Navigate to your "Settings" at the bottom left
Copy your "Developer API Key" and paste it below

About Badger Maps#

The #1 Route Planner for Field Sales.

Action#

Check for existence of key on Data Stores

Description:Check if a key exists in your [Pipedream Data Store](https://pipedream.com/data-stores/) or create one if it doesn't exist.

Version:0.1.4

Key:data_stores-has-key-or-create

View on GitHub

Data Stores Overview#

Data Stores are a key-value store that allow you to persist state and share data across workflows. You can perform CRUD operations, enabling dynamic data management within your serverless architecture. Use it to save results from API calls, user inputs, or interim data; then read, update, or enrich this data in subsequent steps or workflows. Data Stores simplify stateful logic and cross-workflow communication, making them ideal for tracking process statuses, aggregating metrics, or serving as a simple configuration store.

Action Code#

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

export default {
  key: "data_stores-has-key-or-create",
  name: "Check for existence of key",
  description: "Check if a key exists in your [Pipedream Data Store](https://pipedream.com/data-stores/) or create one if it doesn't exist.",
  version: "0.1.4",
  annotations: {
    destructiveHint: false,
    openWorldHint: true,
    readOnlyHint: true,
  },
  type: "action",
  props: {
    app,
    dataStore: {
      propDefinition: [
        app,
        "dataStore",
      ],
    },
    key: {
      propDefinition: [
        app,
        "key",
        ({ dataStore }) => ({
          dataStore,
        }),
      ],
      description: "Enter the key you'd like to check.",
    },
    addRecordIfNotFound: {
      propDefinition: [
        app,
        "addRecordIfNotFound",
      ],
    },
    ttl: {
      propDefinition: [
        app,
        "ttl",
      ],
    },
  },
  async additionalProps() {
    const props = {};
    if (this.app.shouldAddRecord(this.addRecordIfNotFound)) {
      props.value = app.propDefinitions.value;
    }
    return props;
  },
  async run({ $ }) {
    if (await this.dataStore.has(this.key)) {
      $.export("$summary", `Key \`${this.key}\` exists.`);

      return {
        existingKeyFound: true,
        newKeyCreated: false,
      };
    }

    if (!this.app.shouldAddRecord(this.addRecordIfNotFound)) {
      $.export("$summary", `Key \`${this.key}\` does not exist.`);

      return {
        existingKeyFound: false,
        newKeyCreated: false,
      };
    }

    const parsedValue = this.app.parseValue(this.value);

    if (this.ttl) {
      await this.dataStore.set(this.key, parsedValue, {
        ttl: this.ttl,
      });
      $.export("$summary", `Key \`${this.key}\` was not found. Successfully added a new record (expires in ${this.app.formatTtl(this.ttl)}).`);
    } else {
      await this.dataStore.set(this.key, parsedValue);
      $.export("$summary", `Key \`${this.key}\` was not found. Successfully added a new record.`);
    }

    return {
      existingKeyFound: false,
      newKeyCreated: true,
      value: parsedValue,
      ttl: this.ttl || null,
    };
  },
};

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
Data Stores	`app`	`app`	This component uses the Data Stores app.
Data Store	`dataStore`	`data_store`	Select an existing Data Store or create a new one.
Key	`key`	`string`	Select a value from the drop down menu.
Create a new record if the key is not found?	`addRecordIfNotFound`	`string`	Select a value from the drop down menu:`YesNo`
Time to Live (TTL)	`ttl`	`integer`	The number of seconds until this record expires and is automatically deleted. Examples: 3600 (1 hour), 86400 (1 day), 604800 (1 week). Leave blank for records that should not expire.