@flatfile/plugin-webhook-egress

A plugin for egressing data from a Flatfile Workbook to a webhook.

@flatfile/plugin-webhook-egress

The @flatfile/plugin-webhook-egress plugin egresses Flatfile Workbooks to a webhook.

Event Type:

listener.on('{jobParam}') (i.e. listener.on('workbook:submitActionFg'))

Parameters

job · string · required

The job parameter takes the job name.

webhookUrl · string

The webhookUrl parameter takes the webhook url.

Imported NPM Packages

• @flatfile/api@1.5.14+
• @flatfile/listener@0.3.15+
• @flatfile/plugin-job-handler@0.1.1+
• @flatfile/util-common@0.1.1+
• @flatfile/util-response-rejection@0.1.0+
• axios@1.4.0+

Usage

The webhookEgress plugin creates an action that will export workbook data via a webhook. It requires an operation parameter which specifies the event that will initiate the egress. The webhook url can either be passed in as a parameter or set as an environment variable WEBHOOK_SITE_URL.

install

npm i @flatfile/plugin-webhook-egress

import

import { webhookEgress } from "@flatfile/plugin-webhook-egress";

workbook.config.json

  // ... inside Workbook configuration
  "actions": [
    {
      operation: 'submitActionFg',
      mode: 'foreground',
      label: 'Send to...',
      type: 'string',
      description: 'Submit this data to a webhook.',
      primary: true,
    }
  ]
  // ...

listener.js

// Using the WEBHOOK_SITE_URL environment variable
listener.use(webhookEgress("workbook:submitActionFg"));

// Passing the webhook url as a parameter
listener.use(webhookEgress("workbook:submitActionFg", "https://webhook.site/...""));

See the code

@flatfile/plugin-webhook-egress