Integration and invitation settings

The Incident Report Integration tab lets you configure settings for your organization's incident report integration.

The incident report integrations settings support integrations between Axon Community Request and external reporting systems. When this integration is set up, evidence collected from a public portal through a custom workflow specific to your organization can be directly submitted to Axon Evidence. This feature is part of Community Request+, which is included with Axon Evidence Pro+, OSP+, and OSP Premium plans or it can be added to your Axon program by contacting your Customer Success Manager.

Owners and retention categories

When setting up an incident report integration, you must specify two types of owners:

  • Request Owner: To notify the request owner when a portal is created, turn on the Notify invitation owner when portal is created setting.
  • Evidence Owner: Determine whether or not to enable the two settings associated with the Evidence Owner:
    • Notify evidence owner when evidence is submitted: the evidence owner will receive an email when evidence is submitted.
    • Auto-accept submissions into evidence and place them in active status: If this setting is not enabled, users must manually accept or decline each evidence submission.

Use the Default Retention Category Group setting to indicate which retention category is applied to evidence uploaded through the incident report integration. For more information, see categories and retention policies.

API clients

Follow these steps to generate API client credentials and create an API client for the incident report integration:

  1. In the API Clients section, select Add New.
  2. Enter a Client Name for the integration. (we recommend naming integrations after the connected application
    Note

    It's recommended to name integrations after the connected application.

  3. Select Create Client.
    • The required permissions will automatically be provisioned. Specifically, API clients created this way will only have permissions to create, update, and send additional invites for incident report portals.
  4. In the confirmation window, copy the provided API client credentials to use in the partner application.

These API requests support the following actions to manage incident report portals and their associated invites:

  • Create - POST {baseURL}/api/pes-portals/incident-report
  • Update - PATCH {baseURL}/api/pes-portals/incident-report/{portalId}
  • Create Invite - POST {baseURL}/api/pes-portals/incident-report/{portalId}/invite-link

For more information, see Axon Evidence developer documentation.

To view the Client ID or Partner ID for an API client, or to update the Client Name in Axon Evidence, select the pencil icon.

To end any connection, delete it by selecting the trash can icon. When a client is removed, any further interaction from a previously configured integration is blocked by Axon immediately upon removal.

Invite settings

The Invite Settings tab lets you configure settings for both individual invites and public portals.

Individual invite settings

The settings in this section all relate to requests that are created for individuals.

Incident info

In the Incident Info section, select if the ID, Categories, and Description fields are not required, required, or not shown.

  • If Required is selected, the evidence collector must enter the information before a 1-on-1 invitation is sent.
  • If Do Not Show is selected, the field is not shown to the evidence collector.

Community member info

In the Community Member Info section, turn on the Require contact information to be stored in Axon Evidence setting to store the contact information of the community member when individual invitations are created.

Select which contact information fields are required whenever contact information is stored in Axon Evidence.

You can also set the community member's date of birth to Do Not Show.

Auto-accept submissions

Select the Auto-Accept Submissions setting for individual invitations.

When on, submissions from individual invitations are automatically accepted and place in active status. Otherwise, users must manually accept or decline each evidence submission.

Send reminders for request invites

To automatically send reminders after an invite, select Send reminders for Community Request invites.

Note

Automated reminders are not currently available for customers in the European legacy, and U.S. Federal regions.

Public portal settings

In the Community Member Info section, turn on the Require contact information to be stored in Axon Evidence setting to store the contact information of the community member when individual invitations are created.

Select which contact information fields are required whenever contact information is stored in Axon Evidence.

You can also set the community member's date of birth to Do Not Show.