Configuring package processing webhooks
Admins can create one or more webhooks to notify external systems (using a POST call) when a package is uploaded. For example, a webhook request can initiate an IBM Aspera Orchestrator workflow. Configure filters to execute the applicable webhook for each uploaded package. Faspex does not process to any response to the POST request.
{
"faspex_pkg_directory":"/package test - 61ae5292-d8ef-496e-8b15-8cdc0379fc4a.aspera-package/PKG - package test",
"faspex_pkg_name":"Test files",
"faspex_pkg_note":"",
"faspex_pkg_id":506,
"faspex_pkg_delivery_id":506,
"faspex_recipient_list":"aspera-recipient-test@ibm.com",
"faspex_recipient_count":1,
"faspex_sender_id":30,
"faspex_sender_name":"aspera-sender-test@ibm.com",
"faspex_sender_email":"aspera-sender-test@ibm.com",
"faspex_pkg_total_bytes":4633,
"faspex_pkg_total_files":1,
"faspex_pkg_uuid":"61ae5299-d8ea-496e-8b15-8cdc0379fc4a",
"faspex_metadata_fields": "{\"_pkg_uuid\":\"61ae5292-d8ef-496e-8b15-8cdc0379fc4a\",\"_pkg_name\":\"Test files\",\"_created_utc\":\"2022-1209T17:47:03.545Z\"}",
"faspex_recipient_0":"aspera-sender-test@ibm.com"
}
- Identify the endpoint of the external system for the webhook to notify.
- In the Faspex web UI, go to Admin > Package processing > Create new webhook.
- Configure the webhook.
Field name Description Name A unique, descriptive label for this webhook. Webhook endpoint URI The full URI to the external system. HTTPS Create a secure connection to the URI. Webhook connection timeout Defines (in seconds) how long the system should wait for URI connection before the attempt times out. In the event of a connection timeout, Faspex retries the connection once. Valid values: 1 to 600; default 60. Active To enable this webhook, click the toggle to On. To disable, click the toggle to Off. - Configure the filters.
All configured filters must match the uploaded package attributes for the webhook to activate for that package. All fields in this section are optional. When you select Exact match, the package attribute must match the configured filter exactly to activate the webhook. If you don't select Exact match, the text you enter can match any part of the package attribute.
Filter name Apply the webhook when... Package name The package name matches the string. Sender username The sender username matches the string. Sender email The sender email address matches the string. Recipient usernames The recipient usernames match the string. Workgroups and shared inboxes are not supported as recipients.Recipient emails The recipient email addresses match the string. Workgroups and shared inboxes are not supported as recipients.Package message The package note matches the string. Package start date Package end date
The package date falls into the configured range. Minimum package size Maximum package size
The package size (in bytes) falls into the configured range. Note: The maximum supported package size is 8191 TB. - Click Create.
Monitor package processing
Click Jobs for an activity list. Filter as required per webhook or status.
Go to Admin > Job health > Webhook jobs for details. See also Job health monitoring.