Pingwire’s API provides several endpoints for handling pings programmatically:

1. List Pings 

Retrieve a list of all saved pings with filtering and sorting options. Query Parameters:

• _sort: Sort by id, createdAt, description, or entities.
• _order: Define sorting order (ASC or DESC).
• status: Filter by status (Pending, Resolved, Confirmed, Ignored).
• _start & _end: Define pagination limits.

2. Create a Ping 

Create a new ping by sending the required attributes:

• Entities (list of involved entities)
• Description (explanation of detected activity)
• Score (risk level contribution)
• Risk Timeline (schedule for decreasing risk impact)
• Case ID (the associated case)

Additionally, pings can also be created manually through the Pingwire interface. To do this, navigate to the relevant case and click the “Create Ping” button in the section regarding Pings. This could be useful if you want to register an event or activity that wasn't detected automatically but still requires tracking within the case.

3. Update Ping Status 

Modify the status and provide necessary updates:

• Status: Pending, Resolved, Confirmed, Ignored.
• Comment: Justification for the status change.
• Score (if Confirmed, must be set between 0-100).
• Ignore Rule Duration: Define how long the system should suppress similar pings.
• Override Recommendation: Specify Proceed, Review, or Block.

4. Retrieve a Specific Ping 

• Obtain detailed information about a particular ping using its unique id.

5. Add Comments to a Ping 

• Attach comments to a ping for internal tracking and discussion.