Search Products with Akeneo API on New Scheduled Tasks from Pipedream API

Pipedream makes it easy to connect APIs for Akeneo, Pipedream and 2,800+ other apps remarkably fast.

Trigger workflow on

New Scheduled Tasks from the Pipedream API

Next, do this

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

Select this integration
Configure the New Scheduled Tasks trigger
1. Connect your Pipedream account
2. Optional- Configure Secret
Configure the Search Products action
1. Connect your Akeneo account
2. Optional- Configure Search
3. Optional- Select a Scope
4. Optional- Select a Locale
5. Optional- Select a Attributes
6. Optional- Configure Convert Measurements
7. Optional- Configure With Count
8. Optional- Configure With Attribute Options
9. Optional- Configure With Asset Share Links
10. Optional- Configure With Quality Scores
11. Optional- Configure With Completeness
12. Optional- Configure Page
13. Optional- Configure Limit
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 Scheduled Tasks on Pipedream

Description:Exposes an HTTP API for scheduling messages to be emitted at a future time

Version:0.3.1

Key:pipedream-new-scheduled-tasks

View on GitHub

Pipedream Overview#

Pipedream is an API that allows you to build applications that can connect to
various data sources and processes them in real-time. You can use Pipedream to
create applications that can perform ETL (Extract, Transform, and Load) tasks,
as well as to create data-driven workflows.

Some examples of applications you can build using the Pipedream API include:

An application that can extract data from a database, transform it, and then
load it into another database.
An application that can monitor a data source for changes, and then trigger a
workflow in response to those changes.
An application that can poll an API for new data, and then process that data
in real-time.

Trigger Code#

import pipedream from "../../pipedream.app.mjs";
import sampleEmit from "./test-event.mjs";
import { uuid } from "uuidv4";

export default {
  key: "pipedream-new-scheduled-tasks",
  name: "New Scheduled Tasks",
  type: "source",
  description:
    "Exposes an HTTP API for scheduling messages to be emitted at a future time",
  version: "0.3.1",
  dedupe: "unique", // Dedupe on a UUID generated for every scheduled task
  props: {
    pipedream,
    secret: {
      type: "string",
      secret: true,
      label: "Secret",
      optional: true,
      description:
        "**Optional but recommended**: if you enter a secret here, you must pass this value in the `x-pd-secret` HTTP header when making requests",
    },
    http: {
      label: "Endpoint",
      description: "The endpoint where you'll send task scheduler requests",
      type: "$.interface.http",
      customResponse: true,
    },
    db: "$.service.db",
  },
  methods: {
    // To schedule future emits, we emit to the selfChannel of the component
    selfChannel() {
      return "self";
    },
    // Queue for future emits that haven't yet been delivered
    queuedEventsChannel() {
      return "$in";
    },
    httpRespond({
      status, body,
    }) {
      this.http.respond({
        headers: {
          "content-type": "application/json",
        },
        status,
        body,
      });
    },
    async selfSubscribe() {
      // Subscribe the component to itself. We do this here because even in
      // the activate hook, the component isn't available to take subscriptions.
      // Scheduled tasks are sent to the self channel, which emits the message at
      // the specified delivery_ts to this component.
      const isSubscribedToSelf = this.db.get("isSubscribedToSelf");
      if (!isSubscribedToSelf) {
        const componentId = process.env.PD_COMPONENT;
        const selfChannel = this.selfChannel();
        console.log(`Subscribing to ${selfChannel} channel for event source`);
        console.log(
          await this.pipedream.subscribe(componentId, componentId, selfChannel),
        );
        this.db.set("isSubscribedToSelf", true);
      }
    },
    validateEventBody(event, operation) {
      const errors = [];

      // Secrets are optional, so we first check if the user configured
      // a secret, then check its value against the prop (validation below)
      if (this.secret && event.headers["x-pd-secret"] !== this.secret) {
        errors.push(
          "Secret on incoming request doesn't match the configured secret",
        );
      }

      if (operation === "schedule") {
        const {
          timestamp,
          message,
        } = event.body;
        // timestamp should be an ISO 8601 string. Parse and check for validity below.
        const epoch = Date.parse(timestamp);

        if (!timestamp) {
          errors.push(
            "No timestamp included in payload. Please provide an ISO8601 timestamp in the 'timestamp' field",
          );
        }
        if (timestamp && !epoch) {
          errors.push("Timestamp isn't a valid ISO 8601 string");
        }
        if (!message) {
          errors.push("No message passed in payload");
        }
      }

      return errors;
    },
    scheduleTask(event) {
      const errors = this.validateEventBody(event, "schedule");
      let status, body;

      if (errors.length) {
        console.log(errors);
        status = 400;
        body = {
          errors,
        };
      } else {
        const id = this.emitScheduleEvent(event.body, event.body.timestamp);
        status = 200;
        body = {
          msg: "Successfully scheduled task",
          id,
        };
      }

      this.httpRespond({
        status,
        body,
      });
    },
    emitScheduleEvent(event, timestamp) {
      const selfChannel = this.selfChannel();
      const epoch = Date.parse(timestamp);
      const $id = uuid();

      console.log(`Scheduled event to emit on: ${new Date(epoch)}`);

      this.$emit(
        {
          ...event,
          $channel: selfChannel,
          $id,
        },
        {
          name: selfChannel,
          id: $id,
          delivery_ts: epoch,
        },
      );

      return $id;
    },
    async cancelTask(event) {
      const errors = this.validateEventBody(event, "cancel");
      let status, msg;

      if (errors.length) {
        console.log(errors);
        status = 400;
        msg = "Secret on incoming request doesn't match the configured secret";
      } else {
        try {
          const id = event.body.id;
          const isCanceled = await this.deleteEvent(event);
          if (isCanceled) {
            status = 200;
            msg = `Cancelled scheduled task for event ${id}`;
          } else {
            status = 404;
            msg = `No event with ${id} found`;
          }
        } catch (error) {
          console.log(error);
          status = 500;
          msg = "Failed to schedule task. Please see the logs";
        }
      }

      this.httpRespond({
        status,
        body: {
          msg,
        },
      });
    },
    async deleteEvent(event) {
      const componentId = process.env.PD_COMPONENT;
      const inChannel = this.queuedEventsChannel();

      // The user must pass a scheduled event UUID they'd like to cancel
      // We lookup the event by ID and delete it
      const { id } = event.body;

      // List events in the $in channel - the queue of scheduled events, to be emitted in the future
      const events = await this.pipedream.listEvents(
        componentId,
        inChannel,
      );
      console.log("Events: ", events);

      // Find the event in the list by id
      const eventToCancel = events.data.find((e) => {
        const { metadata } = e;
        return metadata.id === id;
      });

      console.log("Event to cancel: ", eventToCancel);

      if (!eventToCancel) {
        console.log(`No event with ${id} found`);
        return false;
      }

      // Delete the event
      await this.pipedream.deleteEvent(
        componentId,
        eventToCancel.id,
        inChannel,
      );
      return true;
    },
    emitEvent(event, summary) {
      // Delete the channel name and id from the incoming event, which were used only as metadata
      const id = event.$id;
      delete event.$channel;
      delete event.$id;

      this.$emit(event, {
        summary: summary ?? JSON.stringify(event),
        id,
        ts: +new Date(),
      });
    },
  },
  async run(event) {
    await this.selfSubscribe();

    const { path } = event;
    if (path === "/schedule") {
      this.scheduleTask(event);
    } else if (path === "/cancel") {
      await this.cancelTask(event);
    } else if (event.$channel === this.selfChannel()) {
      this.emitEvent(event);
    }
  },
  sampleEmit,
};

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
Pipedream	`pipedream`	`app`	This component uses the Pipedream app.
Secret	`secret`	`string`	Optional but recommended: if you enter a secret here, you must pass this value in the `x-pd-secret` HTTP header when making requests
N/A	`http`	`$.interface.http`	This component uses `$.interface.http` to generate a unique URL when the component is first instantiated. Each request to the URL will trigger the `run()` method of the component.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.

Trigger Authentication#

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

About Pipedream#

Integration platform for developers

Action#

Search Products on Akeneo

Description:Search products from Akeneo. [See the documentation](https://api.akeneo.com/api-reference.html#get_products)

Version:0.0.1

Key:akeneo-search-products

View on GitHub

Akeneo Overview#

The Akeneo API empowers users to streamline product information management by automating data exchange between Akeneo and other systems. By leveraging Pipedream, you can construct workflows that trigger actions based on events in Akeneo, sync product data across platforms, enhance product information with data from external sources, and keep sales channels up-to-date with the latest catalog details.

Action Code#

import akeneo from "../../akeneo.app.mjs";
import { ConfigurationError } from "@pipedream/platform";

export default {
  key: "akeneo-search-products",
  name: "Search Products",
  description: "Search products from Akeneo. [See the documentation](https://api.akeneo.com/api-reference.html#get_products)",
  version: "0.0.1",
  type: "action",
  props: {
    akeneo,
    search: {
      type: "string",
      label: "Search",
      description: "Filter products, for more details see the [Filters](https://api.akeneo.com/documentation/filter.html) section",
      optional: true,
    },
    scope: {
      propDefinition: [
        akeneo,
        "channelCode",
      ],
      label: "Scope",
      description: "Filter product values to return scopable attributes for the given channel as well as the non localizable/non scopable attributes, for more details see the [Filter product values via channel](https://api.akeneo.com/documentation/filter.html#via-channel) section",
      optional: true,
    },
    locales: {
      propDefinition: [
        akeneo,
        "locale",
      ],
      description: "Filter product values to return localizable attributes for the given locales as well as the non localizable/non scopable attributes, for more details see the [Filter product values via locale](https://api.akeneo.com/documentation/filter.html#via-locale) section",
      optional: true,
    },
    attributes: {
      propDefinition: [
        akeneo,
        "attribute",
      ],
      label: "Attributes",
      description: "Filter product values to only return those concerning the given attributes, for more details see the [Filter on product values](https://api.akeneo.com/documentation/filter.html#filter-product-values) section",
      optional: true,
    },
    convertMeasurements: {
      type: "boolean",
      label: "Convert Measurements",
      description: "Convert values of measurement attributes to the unit configured in the channel provided by the parameter \"scope\". Therefore, this parameter requires the \"scope\" parameter to be provided.",
      optional: true,
    },
    withCount: {
      type: "boolean",
      label: "With Count",
      description: "Return the count of items in the response. Be careful: on large catalogs, enabling counts can significantly impact performance.",
      optional: true,
    },
    withAttributeOptions: {
      propDefinition: [
        akeneo,
        "withAttributeOptions",
      ],
    },
    withAssetShareLinks: {
      propDefinition: [
        akeneo,
        "withAssetShareLinks",
      ],
    },
    withQualityScores: {
      propDefinition: [
        akeneo,
        "withQualityScores",
      ],
    },
    withCompletenesses: {
      propDefinition: [
        akeneo,
        "withCompletenesses",
      ],
    },
    page: {
      type: "integer",
      label: "Page",
      description: "The page number to return",
      optional: true,
    },
    limit: {
      type: "integer",
      label: "Limit",
      description: "The number of items to return per page",
      optional: true,
    },
  },
  async run({ $ }) {
    if (this.convertMeasurements && !this.scope) {
      throw new ConfigurationError("The `convertMeasurements` parameter requires the `scope` parameter to be provided");
    }

    const response = await this.akeneo.getProducts({
      $,
      params: {
        search: this.search,
        scope: this.scope,
        locales: this.locales,
        attributes: this.attributes,
        convert_measurements: this.convertMeasurements,
        with_count: this.withCount,
        with_attribute_options: this.withAttributeOptions,
        with_asset_share_links: this.withAssetShareLinks,
        with_quality_scores: this.withQualityScores,
        with_completenesses: this.withCompletenesses,
        page: this.page,
        limit: this.limit,
      },
    });

    $.export("$summary", `Found ${response._embedded.items.length} products`);
    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
Akeneo	`akeneo`	`app`	This component uses the Akeneo app.
Search	`search`	`string`	Filter products, for more details see the Filters section
Scope	`scope`	`string`	Select a value from the drop down menu.
Locale	`locales`	`string`	Select a value from the drop down menu.
Attributes	`attributes`	`string`	Select a value from the drop down menu.
Convert Measurements	`convertMeasurements`	`boolean`	Convert values of measurement attributes to the unit configured in the channel provided by the parameter "scope". Therefore, this parameter requires the "scope" parameter to be provided.
With Count	`withCount`	`boolean`	Return the count of items in the response. Be careful: on large catalogs, enabling counts can significantly impact performance.
With Attribute Options	`withAttributeOptions`	`boolean`	Return labels of attribute options in the response. See the`linked_data` format section for more details.
With Asset Share Links	`withAssetShareLinks`	`boolean`	Return asset collection share link urls in the response. See the `linked_data` format section for more details.
With Quality Scores	`withQualityScores`	`boolean`	Return product quality scores in the response
With Completeness	`withCompletenesses`	`boolean`	Return product completenesses in the response
Page	`page`	`integer`	The page number to return
Limit	`limit`	`integer`	The number of items to return per page

Action Authentication#

Akeneo uses OAuth authentication. When you connect your Akeneo account, Pipedream will open a popup window where you can sign into Akeneo and grant Pipedream permission to connect to your account. Pipedream securely stores and automatically refreshes the OAuth tokens so you can easily authenticate any Akeneo API.

Pipedream requests the following authorization scopes when you connect your account:

About Akeneo#

Product information management and data intelligence software

More Ways to Connect Akeneo + Pipedream#

Other Popular Integrations#

Create A New Product Media File with Akeneo API on New Scheduled Tasks from Pipedream API

Pipedream + Akeneo

Try it

Delete Product with Akeneo API on New Scheduled Tasks from Pipedream API

Pipedream + Akeneo

Try it

Get Draft with Akeneo API on New Scheduled Tasks from Pipedream API

Pipedream + Akeneo

Try it

Get Product with Akeneo API on New Scheduled Tasks from Pipedream API

Pipedream + Akeneo

Try it

Submit Product For Approval with Akeneo API on New Scheduled Tasks from Pipedream API

Pipedream + Akeneo

Try it

Popular Triggers#

New Scheduled Tasks from the Pipedream API

Exposes an HTTP API for scheduling messages to be emitted at a future time

Try it

New Upcoming Event Alert from the Pipedream API

Emit new event based on a time interval before an upcoming event in the calendar. This source uses Pipedream's Task Scheduler. See the documentation for more information and instructions for connecting your Pipedream account.

Try it

Card Due Date Reminder from the Pipedream API

Emit new event at a specified time before a card is due.

Try it

New Upcoming Calendar Event from the Pipedream API

Emit new event when a Calendar event is upcoming, this source is using reminderMinutesBeforeStart property of the event to determine the time it should emit.

Try it