← Confection

Get Related UUIDs with Confection API

Pipedream makes it easy to connect APIs for Confection and 700+ other apps remarkably fast.

Trigger workflow on
HTTP requests, schedules and app events
Next, do this
Get Related UUIDs with the Confection API
No credit card required
Trusted by 250,000+ developers from startups to Fortune 500 companies:
Trusted by 250,000+ developers from startups to Fortune 500 companies

Developers Pipedream

Getting Started

Create a workflow to Get Related UUIDs with the Confection API. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

  1. Configure the Get Related UUIDs action
    1. Connect your Confection account
    2. Configure UUID
    3. Optional- Configure Likeness Score
    4. Optional- Configure Should the execution of this step be stopped if no results are found?
  2. Select a trigger to run your workflow on HTTP requests, schedules or app events
  3. Deploy the workflow
  4. Send a test event to validate your setup
  5. Turn on the trigger

Details

This is a pre-built, open source component from Pipedream's GitHub repo. The component is 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.

Get Related UUIDs on Confection
Description:This action will retrieve all UUIDs that have a likeness score of at least 50 (default) with the provided UUID. The likeness score can be customized in configuration.
Version:0.0.1
Key:confection-get-related-uuids

Code

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

export default {
  key: "confection-get-related-uuids",
  name: "Get Related UUIDs",
  type: "action",
  version: "0.0.1",
  description:
    "This action will retrieve all UUIDs that have a likeness score of at least 50 (default) with the provided UUID. The likeness score can be customized in configuration.",
  props: {
    confection,
    uuid: {
      propDefinition: [
        confection,
        "uuid",
      ],
      description: "Provide the UUID to retrieve related UUIDs of.",
    },
    likeness: {
      propDefinition: [
        confection,
        "likeness",
      ],
      description:
        "Accepts values 50 to 100. 100 meaning only pull back records where we are certain the UUIDs are the same record",
    },
    stopOnNoResults: {
      propDefinition: [
        confection,
        "stopOnNoResults",
      ],
      description:
        "If set to true, action execution will be halted when no related UUIDs are found and any subsequent steps that rely on data from this step will not be run.",
    },
  },
  async run({ $ }) {
    const data = await this.confection.getRelatedUUIDs(
      this.uuid,
      this.likeness,
      $,
    );

    if (data.related.length === 0 && this.stopOnNoResults === true) {
      throw new Error(
        `No related UUIDs with likeness score greater than or equal to ${this.likeness} were found.`,
      );
    }
    return data;
  },
};

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.
LabelPropTypeDescription
ConfectionconfectionappThis component uses the Confection app.
UUIDuuidstring

Provide the UUID to retrieve related UUIDs of.

Likeness Scorelikenessinteger

Accepts values 50 to 100. 100 meaning only pull back records where we are certain the UUIDs are the same record

Should the execution of this step be stopped if no results are found?stopOnNoResultsboolean

If set to true, action execution will be halted when no related UUIDs are found and any subsequent steps that rely on data from this step will not be run.

Authentication

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

Find your account ID and API keys here: https://dashboard.confection.io/my-keys

Need an account? Using Confection for the first time? Please see our quick-start guide: https://confection.io/quick-start/pipedream

About Confection

Confection collects, stores, and distributes data in a way that's unaffected by client-side disruptions involving cookies, cross-domain scripts, and device IDs. It's also compliant with global privacy laws so it’s good for people too.

About Pipedream

Stop writing boilerplate code, struggling with authentication and managing infrastructure. Start connecting APIs with code-level control when you need it — and no code when you don't.

Into to Pipedream
Watch us build a workflow
Watch us build a workflow
7 min
Watch now ➜
"The past few weeks, I truly feel like the clichéd 10x engineer."
@heyellieday