Audit Plus Audit+ Download App
Knowledge Base

Server Requests

Create Templates Completion Tasks Server Requests

Server requests enable powerful integrations between Audit Plus and external systems through REST APIs. Configure automated HTTP requests that trigger during audit completion or when issues are identified, enabling seamless workflow automation and data synchronization.

Overview

Server requests allow you to:

  • Send audit data to external systems automatically
  • Trigger workflows in third-party applications
  • Create tickets or dispatch requests
  • Update databases with audit results
  • Send notifications or alerts based on audit outcomes

Server requests are stored in app settings and automatically sync across your devices via CloudKit.

Accessing Server Requests

Navigate to: Settings → Server Requests

From this screen you can:

  • View all configured server requests
  • Add new server requests
  • Edit existing requests
  • Delete requests by swiping left
  • See cloud sync status

Creating a Server Request

Basic Configuration

  1. HTTP Method - Select from:
    • GET - Retrieve data
    • POST - Send data
    • PUT - Update entire resource
    • PATCH - Partial update
    • DELETE - Remove resource
    • HEAD - Headers only
    • OPTIONS - Check allowed methods
  2. Name - Give your request a descriptive name
  3. URL - Enter the endpoint URL
    • Select http:// or https:// protocol
    • Enter the full URL path
    • Example: https://api.example.com/audits
  4. Run Request - When to execute:
    • On Completion - Runs when audit is completed
    • On Issue - Triggered manually from issue context menu
  5. Execute Condition (Completion only):
    • Either - Run regardless of audit result
    • Passing - Only run if audit passes
    • Failing - Only run if audit fails

Parameters

Add URL parameters that will be appended to your request:

  • Tap the + button to add parameters
  • Enter key-value pairs
  • Toggle “Ask” to prompt user for value during execution
  • Set a label for user prompts when “Ask” is enabled
  • Parameters automatically update the URL query string

Dynamic Parameters

When “Ask” is enabled, the completion process will pause and prompt the user to enter values. This is useful for:

  • Ticket numbers
  • Reference IDs
  • Custom notes
  • Dynamic categorization

Headers

Configure HTTP headers for your request:

  • Add custom headers with the + button
  • Common headers: Content-Type, Accept, API-Key
  • Headers can also use “Ask” for dynamic values
  • Authorization headers are configured separately

Content Type & Body

For requests that send data (POST, PUT, PATCH), configure the content type:

  • None - No body content
  • application/json - JSON formatted data
  • text/plain - Plain text
  • application/xml - XML formatted data
  • application/x-www-form-urlencoded - Form data
  • Send Audit/Test - Automatically includes complete audit data as JSON

When a content type is selected (except “None” and “Send Audit/Test”), a body editor appears where you can enter the request payload.

Authorization

Configure authentication for secured endpoints:

  1. None - No authentication
  2. Basic Auth
    • Enter username and password
    • Credentials are base64 encoded automatically
  3. Bearer Token
    • Enter authentication token
    • Added to Authorization header as “Bearer {token}“

Testing Requests

Test your configuration before using it in production:

  1. Configure all request parameters
  2. Tap the Test Request button
  3. If parameters use “Ask”, you’ll be prompted to enter values
  4. View the response in the Response section
  5. Enable Show cURL to see the exact request being sent

cURL Output

The cURL output shows the complete request including:

  • Full URL with parameters
  • All headers
  • Authorization details
  • Request body

This is invaluable for debugging and sharing request configurations with developers.

Using Server Requests

During Audit Completion

Requests configured for “On Completion” run automatically when an audit is finished:

  1. Complete all audit questions
  2. Navigate to the completion screen
  3. Server requests execute based on their conditions
  4. If “Ask” parameters exist, you’ll be prompted for values
  5. Requests run in the order they were created

For Issues

Trigger requests manually from identified issues:

  1. In the audit editor, reveal issues
  2. Long press on an issue
  3. Select the server request to execute
  4. If configured, the question details are included as a parameter

Best Practices

  1. Use HTTPS - Always use secure connections for sensitive data
  2. Test Thoroughly - Verify requests work before using in production
  3. Handle Errors - Ensure your server handles various response codes gracefully
  4. Secure Credentials - Store API keys and tokens securely
  5. Use Meaningful Names - Name requests clearly for easy identification
  6. Document Parameters - Use descriptive labels for “Ask” parameters

Common Use Cases

Creating Support Tickets

  • POST to ticketing system API
  • Include audit summary in body
  • Use “Ask” for ticket priority or assignee

Updating Inventory Systems

  • PATCH to update equipment status
  • Include equipment ID as parameter
  • Send pass/fail status in body

Compliance Reporting

  • POST complete audit data
  • Use “Send Audit/Test” content type
  • Execute only on completion

Notification Services

  • POST to webhook URLs
  • Execute on failing audits only
  • Include summary in JSON body

Troubleshooting

Request Fails

  • Check URL is correct and accessible
  • Verify authentication credentials
  • Ensure content type matches server expectations
  • Review cURL output for exact request details

No Response

  • Verify internet connection
  • Check if server requires specific headers
  • Ensure firewall allows outgoing requests

Authentication Errors

  • Verify credentials are correct
  • Check token hasn’t expired
  • Ensure auth type matches server requirements
Next guide
Show Log