Pay or Remove Payment for Invoice with Fakturoid API on New Event Triggered (Instant) from Hippo Video API

Pipedream makes it easy to connect APIs for Fakturoid, Hippo Video and 2,700+ other apps remarkably fast.

Trigger workflow on

New Event Triggered (Instant) from the Hippo Video API

Next, do this

Pay or Remove Payment for Invoice with the Fakturoid 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 Hippo Video trigger and Fakturoid action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Event Triggered (Instant) trigger
1. Connect your Hippo Video account
2. Configure alert
3. Select one or more Event Ids
Configure the Pay or Remove Payment for Invoice action
1. Connect your Fakturoid account
2. Select a Account
3. Select a Invoice ID
4. Select a Action Type
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 Event Triggered (Instant) on Hippo Video

Description:Emit new event when any of the selected events are triggered.

Version:0.0.1

Key:hippo_video-new-triggered-event-instant

View on GitHub

Hippo Video Overview#

The Hippo Video API lets you harness the power of video in your business processes. Through Pipedream, you can automate video creation, management, and distribution workflows. This means you can trigger actions in Hippo Video based on events from other apps, or use Hippo Video events to kick off processes elsewhere. Whether it's automating video emails in your CRM, monitoring video analytics, or managing video content at scale, Pipedream's serverless platform empowers you to build and run workflows seamlessly.

Trigger Code#

import { v4 as uuidv4 } from "uuid";
import { EVENT_OPTIONS } from "../../common/constants.mjs";
import { parseObject } from "../../common/utils.mjs";
import hippoVideo from "../../hippo_video.app.mjs";

export default {
  key: "hippo_video-new-triggered-event-instant",
  name: "New Event Triggered (Instant)",
  description: "Emit new event when any of the selected events are triggered.",
  version: "0.0.1",
  type: "source",
  dedupe: "unique",
  props: {
    hippoVideo,
    db: "$.service.db",
    http: {
      type: "$.interface.http",
      customResponse: true,
    },
    alert: {
      type: "alert",
      alertType: "warning",
      content: "Please note that you can have only one webhook in your Hippo Video account, any change here will overwrite the current webhook configuration.",
    },
    eventIds: {
      type: "string[]",
      label: "Event Ids",
      description: "The Id of the events you want to be triggered.",
      options: EVENT_OPTIONS,
    },
  },
  methods: {
    removeHook() {
      this.hippoVideo.updateWebhook({
        data: {
          url: this.http.endpoint,
          secret_key: uuidv4(),
        },
      });
    },
  },
  hooks: {
    async activate() {
      await this.removeHook();
      await this.hippoVideo.updateWebhook({
        data: {
          events: parseObject(this.eventIds),
          url: this.http.endpoint,
          secret_key: uuidv4(),
        },
      });
    },
    async deactivate() {
      await this.removeHook();
    },
  },
  async run(event) {
    const { body } = event;
    const ts = Date.parse(body.eventTimestamp || new Date());

    this.$emit(body, {
      id: body.hook?.uuid || body.video_token,
      summary: `New event with event name: ${body.eventName || body.type} successfully triggered!`,
      ts: ts,
    });
  },
};

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
Hippo Video	`hippoVideo`	`app`	This component uses the Hippo Video app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
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.
Event Ids	`eventIds`	`string[]`	Select a value from the drop down menu:`{ "value": "3", "label": "Viewing Sessions" }{ "value": "1", "label": "Video Created" }{ "value": "4", "label": "CTA Lead Genaration" }{ "value": "5", "label": "CTA Annotations" }{ "value": "6", "label": "CT" }{ "value": "18", "label": "Video Transcode" }`

Trigger Authentication#

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

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

About Hippo Video#

The Only Interactive Video CX Platform You Ever Need to Create, Send & Track B2B Videos.

Action#

Pay or Remove Payment for Invoice on Fakturoid

Description:Executes payment for an invoice or removes an already applied payment. [See the documentation](https://www.fakturoid.cz/api/v3/invoice-payments)

Version:0.0.1

Key:fakturoid-pay-remove-payment-invoice

View on GitHub

Action Code#

import constants from "../../common/constants.mjs";
import fakturoid from "../../fakturoid.app.mjs";

export default {
  key: "fakturoid-pay-remove-payment-invoice",
  name: "Pay or Remove Payment for Invoice",
  description: "Executes payment for an invoice or removes an already applied payment. [See the documentation](https://www.fakturoid.cz/api/v3/invoice-payments)",
  version: "0.0.1",
  type: "action",
  props: {
    fakturoid,
    accountSlug: {
      propDefinition: [
        fakturoid,
        "accountSlug",
      ],
    },
    invoiceId: {
      propDefinition: [
        fakturoid,
        "invoiceId",
        ({ accountSlug }) => ({
          accountSlug,
        }),
      ],
    },
    actionType: {
      type: "string",
      label: "Action Type",
      description: "Specify if you want to execute or remove a payment",
      options: constants.ACTION_TYPE_OPTIONS,
      reloadProps: true,
    },
  },
  async additionalProps() {
    const props = {};
    if (this.actionType === "execute") {
      props.paidOn = {
        type: "string",
        label: "Paid On",
        description: "Payment date. **Format: YYYY-MM-DD** Default: Today",
        optional: true,
      };
      props.currency = {
        type: "string",
        label: "Currency",
        description: "Currency [ISO Code](https://en.wikipedia.org/wiki/ISO_4217#List_of_ISO_4217_currency_codes) (same as invoice currency)",
        optional: true,
      };
      props.amount = {
        type: "string",
        label: "Amount",
        description: "Paid amount in document currency. Default: Remaining amount to pay",
        optional: true,
      };
      props.markDocumentAsPaid = {
        type: "boolean",
        label: "Mark Document As Paid",
        description: "Mark document as paid? Default: true if the total paid amount becomes greater or equal to remaining amount to pay",
        optional: true,
      };
    } else if (this.actionType === "remove") {
      props.paymentId =  {
        type: "string",
        label: "Payment ID",
        description: "ID of the payment to be removed.",
        options: async () => {
          const { payments } = await this.fakturoid.getInvoice({
            accountSlug: this.accountSlug,
            invoiceId: this.invoiceId,
          });

          return payments.map(({
            id: value, paid_on: pOn, currency, amount,
          }) => ({
            label: `${currency} ${amount} (${pOn})`,
            value,
          }));
        },
      };
    }
    return props;
  },
  async run({ $ }) {
    if (this.actionType === "execute") {
      const response = await this.fakturoid.payInvoice({
        accountSlug: this.accountSlug,
        invoiceId: this.invoiceId,
        data: {
          paid_on: this.paidOn,
          currency: this.currency,
          amount: this.amount && parseFloat(this.amount),
          mark_document_as_paid: this.markDocumentAsPaid,
        },
      });
      $.export("$summary", `Successfully executed payment for invoice ID ${this.invoiceId}`);
      return response;
    } else if (this.actionType === "remove") {
      const response = await this.fakturoid.removePayment({
        $,
        accountSlug: this.accountSlug,
        invoiceId: this.invoiceId,
        paymentId: this.paymentId,
      });
      $.export("$summary", `Successfully removed payment ID ${this.paymentId} from invoice ID ${this.invoiceId}`);
      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
Fakturoid	`fakturoid`	`app`	This component uses the Fakturoid app.
Account	`accountSlug`	`string`	Select a value from the drop down menu.
Invoice ID	`invoiceId`	`string`	Select a value from the drop down menu.
Action Type	`actionType`	`string`	Select a value from the drop down menu:`{ "label": "Execute Payment", "value": "execute" }{ "label": "Remove Payment", "value": "remove" }`

Action Authentication#

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

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