Parameters

jobrequired
string

The job parameter takes the job name.

webhookUrl
string

The webhookUrl parameter takes the webhook url.

Imported NPM Packages

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_actions_primary

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