Skip to content

Commit 1ae6c23

Browse files
authored
Create Asynchronous Callback API for Request Fulfilment
1 parent d0d9106 commit 1ae6c23

File tree

1 file changed

+41
-0
lines changed

1 file changed

+41
-0
lines changed
Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
2+
Use Case:
3+
4+
When a request is created in ServiceNow, it is essential to send the request details to a third-party system via an API gateway (such as GAMS or API Gateway) for fulfilment activities, such as access provisioning or record creation. Given the potential for lengthy processing times due to a high volume of activities, a synchronous integration may lead to timeouts. Therefore, leveraging asynchronous integration allows for efficient handling of such requests.
5+
6+
Proposed Solution:
7+
8+
1. Synchronous Outbound Integration:
9+
> Utilize the REST integration step within the Flow Designer to send request details to the third-party endpoint.
10+
> The third-party system is expected to send an acknowledgment upon receiving the request, confirming that it is being processed.
11+
2. Status Tracking:
12+
> Introduce a new field or leverage an existing field in the sc_req_item table (or another relevant table) to track fulfilment status, with choice values such as "Success" or "Failure."
13+
3. Inbound Import Set API:
14+
> Create an Inbound Import Set API that allows the third-party system to send updates back to ServiceNow. The fields in the import set table should include:
15+
Request Number: A unique identifier for the request.
16+
Fulfilment Status: The status of the fulfilment (e.g., Success or Failure).
17+
Work Notes: Additional comments or information regarding the fulfilment process.
18+
4. Transform Map:
19+
> Establish a Transform Map where:
20+
a. Source Table: The Import Set Table that receives the status updates.
21+
b. Target Table: The sc_req_item table (or another relevant table based on the use case).
22+
c. Define field mappings to ensure accurate data transfer and use coalescing on the Request Number to allow updates only.
23+
d. Map the fulfilment status field from import set to new custom field to store the fulfilment status in sc_req_item table.
24+
5. Flow Changes:
25+
> Update the request stage based on the integration fulfilment status value
26+
6. API Sharing:
27+
> Provide the Inbound Import Set API to the third-party system, enabling it to send fulfilment status updates once the fulfilment process is complete.
28+
29+
Benefits of Asynchronous Callback API:
30+
31+
• Enhanced Performance: Asynchronous processing minimizes the risk of timeouts, ensuring that requests are handled efficiently, even when high volumes of activities are present.
32+
33+
• Improved User Experience: Users are not left waiting for synchronous responses; instead, they can continue working while the third-party system processes their requests.
34+
35+
• Reliable Status Tracking: The introduction of a dedicated status field allows for effective tracking of fulfilment outcomes, facilitating better communication with users regarding the success or failure of their requests.
36+
37+
• Scalability: This approach can easily scale to accommodate increased workloads and additional integrations with other systems, enhancing overall operational capacity.
38+
39+
• Flexibility in Integration: By decoupling request sending and status receiving, organizations can adapt to changes in third-party processes without disrupting their internal workflows.
40+
41+
This asynchronous callback API solution not only streamlines the integration process but also ensures that ServiceNow can effectively manage and track request fulfilment in a robust and user-friendly manner.

0 commit comments

Comments
 (0)