Send workbook data from Flatfile to external webhook endpoints for seamless integration with your systems
operation
name defined in an action in your workbook configuration (e.g., ‘workbook:submitActionFg’).WEBHOOK_SITE_URL
environment variable.webhookUrl
parameter is not provided during initialization, the plugin will look for an environment variable named WEBHOOK_SITE_URL
and use its value as the destination for the data. If neither the parameter nor the environment variable is set, the request will fail. The plugin sends data as a JSON payload in an HTTP POST request with Content-Type: application/json
.
Content-Type: application/json
{}
if no specific response is neededoperation
that matches the job
string passed to the pluginContent-Type: application/json
@flatfile/plugin-job-handler
for job lifecycle management (bundled with the plugin)@flatfile/util-response-rejection
for processing webhook rejection responses@flatfile/util-common
for error loggingrejections
format. These errors are automatically processed and displayed in the Flatfile UI, allowing users to see and correct data issues identified by your backend systems.