Get Article with Omnivore API on New Transaction Created from Recurly API

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

Trigger workflow on

New Transaction Created from the Recurly API

Next, do this

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

Select this integration
Configure the New Transaction Created trigger
1. Connect your Recurly account
2. Configure Polling schedule
Configure the Get Article action
1. Connect your Omnivore account
2. Select a Username
3. Select a Article Slug
4. Optional- Configure Article Format
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 Transaction Created on Recurly

Description:Emit new event when a new transaction is created. [See the docs](https://recurly.com/developers/api/v2021-02-25/index.html#operation/list_transactions).

Version:0.0.1

Key:recurly-new-transaction-created

View on GitHub

Recurly Overview#

Recurly API provides robust functionality for subscription management, including creating and updating customer accounts, managing billing information, and handling subscription lifecycle events. With Pipedream, you can leverage these capabilities to create automated workflows that respond to events in Recurly, sync data with other systems, and perform actions that enhance your subscription operations and customer experiences.

Trigger Code#

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

export default {
  ...common,
  key: "recurly-new-transaction-created",
  name: "New Transaction Created",
  description: "Emit new event when a new transaction is created. [See the docs](https://recurly.com/developers/api/v2021-02-25/index.html#operation/list_transactions).",
  type: "source",
  version: "0.0.1",
  dedupe: "unique",
  methods: {
    ...common.methods,
    listTransactions(args = {}) {
      return this.app.makeRequest({
        method: "listTransactions",
        ...args,
      });
    },
    getResourcesFn() {
      return this.listTransactions;
    },
    getResourcesFnArgs() {
      const lastCreatedAt = this.getLastCreatedAt();
      if (lastCreatedAt) {
        return {
          params: {
            limit: constants.DEFAULT_LIMIT,
            beginTime: lastCreatedAt,
          },
        };
      }
      return {
        params: {
          limit: constants.DEFAULT_LIMIT,
        },
      };
    },
    generateMeta(resource) {
      return {
        id: resource.id,
        ts: Date.parse(resource.createdAt),
        summary: `New Transaction ID ${resource.id}`,
      };
    },
  },
};

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
Recurly	`app`	`app`	This component uses the Recurly 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 Recurly API

Trigger Authentication#

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

To access your API key, navigate to Integrations > API Credentials in your Recurly account (https://[your_subdomain].recurly.com/integrations/api_keys).

About Recurly#

The subscription management platform delivering unrivaled results to smart brands worldwide.

Action#

Get Article on Omnivore

Description:Get a single article and its content. [See the documentation](https://github.com/omnivore-app/omnivore/blob/main/packages/api/src/schema.ts#L2659)

Version:0.0.2

Key:omnivore-get-article

View on GitHub

Omnivore Overview#

The Omnivore API offers a platform to integrate with various Point of Sale (POS) systems, streamlining data access across multiple restaurant locations and systems. With Pipedream, you can harness this API to automate tasks, sync data, and connect with other services like CRMs, messaging apps, or analytics tools. By setting up triggers and actions, workflows can process transactions, update menus, gather sales reports, and more, all in real time.

Action Code#

import app from "../../omnivore.app.mjs";
import article from "../../common/queries/article.mjs";

export default {
  key: "omnivore-get-article",
  name: "Get Article",
  description: "Get a single article and its content. [See the documentation](https://github.com/omnivore-app/omnivore/blob/main/packages/api/src/schema.ts#L2659)",
  type: "action",
  version: "0.0.2",
  props: {
    app,
    username: {
      label: "Username",
      description: "The username of the user.",
      propDefinition: [
        app,
        "userId",
        () => ({
          mapper: ({
            name: label,
            profile: { username: value },
          }) => ({
            label,
            value,
          }),
        }),
      ],
    },
    slug: {
      label: "Article Slug",
      description: "The slug of the article.",
      propDefinition: [
        app,
        "articleId",
        () => ({
          mapper: ({
            node: {
              slug: value,
              title: label,
            },
          }) => ({
            label,
            value,
          }),
        }),
      ],
    },
    format: {
      propDefinition: [
        app,
        "format",
      ],
    },
  },
  methods: {
    getArticle(variables = {}) {
      return this.app.makeRequest({
        query: article.queries.getArticle,
        variables,
      });
    },
  },
  async run({ $: step }) {
    const {
      // eslint-disable-next-line no-unused-vars
      app,
      getArticle,
      ...variables
    } = this;

    const { article: response }
      = await getArticle(variables);

    if (response.errorCodes?.length) {
      throw new Error(JSON.stringify(response, null, 2));
    }

    step.export("$summary", `Successfully retrieved article with ID \`${response.article.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
Omnivore	`app`	`app`	This component uses the Omnivore app.
Username	`username`	`string`	Select a value from the drop down menu.
Article Slug	`slug`	`string`	Select a value from the drop down menu.
Article Format	`format`	`string`	The format of the article.