Integration Request

Back to Integrations

Overview

Below is a business-focused explanation of the Integration Request document, written for operational and managerial users.


Integration Request – Business Overview

What the Integration Request is used for

The Integration Request is used to formally record, track, and monitor the exchange of information between Dafater and external systems. It acts as a business log that shows when data was sent or received, what the purpose was, and whether the exchange was successful or needs attention.

In simple terms, it helps the business ensure that integrations with banks, payment providers, government platforms, third-party service providers, or partner systems are working as expected and that data is flowing correctly.


Prerequisites and setup before using Integration Request

Before the Integration Request is used effectively, the following should be in place:

No technical knowledge is required for daily use, but business ownership of each integration is important.


Typical workflow and how it fits into business processes

  1. Business activity triggers an integration
    A business action such as submitting a payment, requesting customer verification, or updating account information requires communication with an external system.

  2. Integration Request is created automatically
    Each exchange is recorded as an Integration Request, capturing the purpose and current status of the interaction.

  3. Status is reviewed by business users
    Users can see whether the request is:

    • Successfully completed
    • Still in progress
    • Failed and requiring follow-up
  4. Follow-up and resolution
    If an issue occurs, business users can coordinate with internal teams or external partners to resolve it, using the Integration Request as the reference.

  5. Audit and reporting
    The Integration Request remains available for audits, compliance checks, and performance reviews.


Key business scenarios where Integration Request is essential

The Integration Request is especially important in scenarios such as:

In these cases, the Integration Request provides transparency and accountability for every interaction.


Important considerations for users


In summary, the Integration Request helps the business maintain control, visibility, and confidence over all external system interactions, ensuring smooth operations and timely issue resolution.

Basic Information

Fields

Field Name Label Type Required Options Description
request_id Request ID Data - Unique identifier for the integration request in Dafater
integrationrequestservice Service Data - External or internal service used for this Dafater integration
isremoterequest Is Remote Request? Check - Indicates whether the request is executed on a remote system
request_description Request Description Data - Business description explaining the purpose of the integration request
status Status Select , Queued, Authorized, Completed, Cancelled, Failed Current processing status of the integration request in Dafater
url URL Small Text - Target endpoint URL used for sending the integration request
request_headers Request Headers Code - Technical headers sent with the integration request
data Request Data Code - Payload data sent to the external or internal service
output Output Code - Response received after processing the integration request
error Error Code - Error details captured if the integration request fails
reference_doctype Reference Document Type Link DocType Dafater document type linked to this integration request
reference_docname Reference Document Name Dynamic Link reference_doctype Specific Dafater document associated with this integration request

Permissions

Role Read Write Create Delete Submit Cancel
System Manager