SharePoint Webhooks screen

Shows information about the workflow and eForm associations created in SharePoint for Microsoft 365.

Background and Setup

Examples

Prerequisites

Good to Know

  • This screen shows the information when you associate an AgilePoint NX app with a SharePoint list in SharePoint for Microsoft 365. AgilePoint NX uses SharePoint webhooks to monitor the information from SharePoint for Microsoft 365 when specific events occur, such as a list item is added, updated, or deleted.
    • When you associate a process-based app with a SharePoint list, it enables the app to start when you create a new item or change an item on your SharePoint site.
    • When you associate a form-based app with a SharePoint list, it replaces the default SharePoint list forms to use in your SharePoint site.

    For more information, refer to Install and Configure AgilePoint Intelligent Process Automation for Microsoft 365.

How to Start

  1. Click Manage.

    Click Manage
  2. In Manage Center, click System > SharePoint Webhooks.

    Click SharePoint Webhooks

SharePoint Webhooks > Workflow Association tab

Shows information about the workflow associations created between the process-based apps and SharePoint lists in SharePoint for Microsoft 365.

Figure: SharePoint Webhooks > Workflow Association tab

SharePoint Webhooks Workflow Association tab

Fields

Field NameDefinition

Search

Description:
Does a search of the workflow associations based on the specified criteria.

Name

Description:
Shows the name of the SharePoint workflow created in SharePoint for Microsoft 365.
Allowed Values:
Read only.

Web URL

Description:
Shows the URL of the SharePoint site for the workflow association.
Allowed Values:
Read only.

List Name

Description:
Shows the name of the SharePoint list for the workflow association.
Allowed Values:
Read only.

Status

Description:
Shows the status of the workflow association.
Allowed Values:
Read only.

The status can be Active or Inactive.

Initiation Events

Description:
Shows the events configured in the workflow association to start an app.
Allowed Values:
Read only.

Process Name

Description:
Shows the name of the primary process model for the app associated with the SharePoint workflow.
Allowed Values:
Read only.

Version

Description:
Shows the version number of the app associated with the SharePoint workflow.
Allowed Values:
Read only.

SharePoint Webhooks > List Form Association tab

Shows information about the eForm associations created between the form-based apps and SharePoint lists in SharePoint for Microsoft 365.

Figure: SharePoint Webhooks > List Form Association tab

SharePoint Webhooks List Form Association tab

Fields

Field NameDefinition

Search

Description:
Does a search of the workflow associations based on the specified criteria.

Web URL

Description:
Shows the URL of the SharePoint site for the eForm association.
Allowed Values:
Read only.

List Name

Description:
Shows the name of the SharePoint list for the eForm association.
Allowed Values:
Read only.

Content Type Name

Description:
Shows the content type of the SharePoint list.
Allowed Values:
Read only.

Content Type ID

Description:
Shows the unique identifier of the content type used for the SharePoint list. This ID comes from SharePoint.
Allowed Values:
Read only.

Form App

Description:
Shows the name of the form-based app associated with a SharePoint list and used in place of the default SharePoint list form.
Allowed Values:
Read only.

Display Form

Description:
Shows the name of the View form associated with the form-based app that replaces the default SharePoint list form.
Allowed Values:
Read only.

Edit Form

Description:
Shows the name of the Update form associated with the form-based app that replaces the default, editable SharePoint list form.
Allowed Values:
Read only.

New Form

Description:
Shows the name of the New form associated with the form-based app that replaces the default SharePoint list form to create a new list item.
Allowed Values:
Read only.

SharePoint Webhooks > Workflow Audit Logs tab

Shows information about the SharePoint workflows that are associated with AgilePoint NX apps.

Figure: SharePoint Webhooks > Workflow Audit Logs tab

SharePoint Webhooks Workflow Audit Logs tab

Fields

Field NameDefinition

Search

Description:
Does a search of the audit logs based on the specified criteria.

Filter

Opens this Screen:
Filters screen
Description:
Filters the SharePoint audit logs based on the specified date range.

Web URL

Description:
Shows the URL of the SharePoint site for the workflow association.
Allowed Values:
Read only.

List Name

Description:
Shows the name of the SharePoint list for the workflow association.
Allowed Values:
Read only.

Item ID

Description:
Shows the SharePoint ID of the SharePoint list item added, updated, or deleted.
Allowed Values:
Read only.

Process Model

Description:
Shows the name of the primary process model for the app associated with the SharePoint workflow.
Allowed Values:
Read only.

Status

Description:
Specifies whether a process instance started successfully from SharePoint for Microsoft 365.
Allowed Values:
Read only.

The status can be one of these:

  • Success - The process instance was started.
  • Failed - The process instance failed to start.
  • Skipped - The process instance was not started because a process instance is already running for the SharePoint list item.

Event Type

Description:
Shows the event that triggered the app.
Allowed Values:
Read only.

Event Time

Description:
Shows the date and time the event was triggered.
Allowed Values:
Read only.

Description

Description:
Shows a description of the error if an error occurs.
Allowed Values:
Read only.

Filters screen

Filters the SharePoint audit logs based on the specified date range.

Figure: Filters screen

Filters screen

Fields

Field NameDefinition

Date Range

Description:
Does a search of the logs based on the specified date range.
Allowed Values:
  • Today
  • Last 7 Days
  • Last 15 Days
  • Last 30 Days
  • In last No Of days
  • Between
Default Value:
Today