Configure the Approval Task

You're viewing Apigee X documentation.
View Apigee Edge documentation.

The Approval task lets you temporarily suspend the execution of an integration until the suspension is manually resolved.

When an integration reaches an Approval task, execution is halted. All tasks after the Approval task are not run. The integration resumes only after an author manually approves or rejects the suspension. Use this task when manual intervention in a task is required.

Configure the Approval task

To configure the Approval task:

  1. Go to the Apigee UI and sign in.
  2. Select your organization using the drop-down menu in the upper left corner of the UI.
  3. Click Develop > Integrations.
  4. Search for or select the integration to edit from the Integrations list and click to view the integration designer.
  5. Click + Add a task/trigger > Tasks to display a list of available tasks.
  6. Drag the Approval task element to the integration designer.
  7. Click the Approval task element on the designer to view the Approval task configuration pane.
  8. Configure the remaining fields using the Configuration properties for the task as detailed in the tables below.
  9. Changes to the properties are saved automatically.

Configuration properties

The following table describes the configuration properties of the Approval task.

Property Data type Description
Recipients String Array Email addresses to which notification is sent when the task is suspended. Enter multiple email addresses separated by a comma.
Custom notification message String Custom message to include in the email notification when the task is suspended. The value can be a literal or a variable. If the custom message is available in a variable, click VAR and select the variable.
Reminder frequency (in minutes) Integer Frequency of reminder notifications.

If the suspension is in an unresolved state, you can send reminder email notifications requesting authorized users to resolve the suspension.

Time until expiration (in minutes) Integer Time period of the suspension.

If the suspension is not resolved within the time, the suspension is rejected by default.

On expiration Boolean Action to be taken after the suspension has expired.

You can choose either to reject the suspension or lift the suspension. By default the suspension is rejected.

isApproved (Approval) Boolean Output variable which has the status of the suspension after resolution.

The isApproved variable is set to True if the suspension is approved and set to False if the suspension is rejected.

Retry on failure

You can configure various retry strategies to handle errors in a task. The retry strategies allow you to specify how to rerun the task in case of an error. For more information, see Error handling strategies.