Skip to main content

People API - QWF Configuration for Assignment Package Batch Status

Assignment package batches in AssignmentPro can be created through a POST request. If there are assignment packages processed through the POST request that have failed, it is recommended to configure

Updated over 2 weeks ago

Assignment package batches in AssignmentPro can be created through a POST request. If there are assignment packages processed through the POST request that have failed, it is recommended to configure a quick workflow to send a webhook notification to the external system for the status.

To notify the external site that raised the request about the status of the Assignment Packages, the quick workflow should be configured to trigger whenever the status of an Assignment Package Batch changes.

Quick Workflow Details

The quick workflow details are:

  • Name: Assignment Package Batch Status

  • Data Type: Assignment

  • Take Action: When Target Field Value Changes

  • Data Source: Assignment Package

  • Target Field: Batch Status

QWF Details

Alert Only If These Conditions Are True

Conditions will be added for the Company of which the Assignment Package Batch was generated in, and the User that created the Assignment Package.

Additionally, the quick workflow will only send out the notification to the external site if the batch status is Completed, Processed with Errors, or Failed.

QWF Conditions

Webhook Notification

The following fields can be added to the webhook notification:

  • Assignment Package ID

  • Assignment Package Batch Status

  • Cost Estimate ID

  • Number of Cost Estimate Errors

  • Number of Compensation Calculation Errors

  • Message: "The assignment package has finished generating."

QWF Webhook
Did this answer your question?