CreateIncidentReceipt Message

The CreateIncidentReceipt Message is the asynchronous receipt that is sent after processing the Createincident Message.

You will have been redirected to the Messages page after submitting the Response Message. If navigating from elsewhere, click the 'Messages' icon and you will see the following screen (note: the previously configured message is visible in the list):

1) Click New.

New Message Modal

The fields to be configured for the CreateIncidentReceipt New Message modal are as follows:

#	Field	Description	Value
2	Message name	The message name that is unique for this integration.	'CreateIncidentReceipt'
3	Type	The primary purpose of the message.	'Receipt'
4	Direction	The direction(s) this message is configured to support. (Choices: Inbound, Outbound, Bidirectional)	'Bidirectional'

Your CreateIncidentReceipt New Message modal should look like this:

5) Submit and view to further configure the Message.

Response Fields

Navigate to Message > Response.

The Response fields to be configured are as follows:

#	Field	Description	Value
6	Response	The immediate synchronous response to this message.	<lookup: 'Response'>

Your Response form should look like this:

7) Navigate to Message > Bond.

Bond Fields

The Bond fields to be configured are as follows:

#	Field	Description	Value
8	Set bond state inbound*	Set the Bond State when receiving this message. Use 'None' to leave the Bond State alone or to modify it via a Message/Field Stage to Target script.	'Open'

*Set bond state choices: None, Pending, Open, Suspended, Vendor suspended, Closed

Your Bond form should look like this:

9) Navigate to Inbound > Settings.

Inbound Settings Fields

The Inbound Settings fields to be configured are as follows:

#	Field	Description	Value
10	Reference lookup script	The script containing functions for extracting internal and external references from the request payload.	Update the code in the Reference lookup script field so that it looks like the code below

The code in the 'Reference lookup script' field should look like this:

var answer = {};

answer.getExternalMessageID = function (payload, request) {
  return '' + (payload.message.source_id || '');
};

answer.getInternalMessageID = function (payload, request) {
  return '' + (payload.message.target_id || '');
};

Reference lookup script: In an asynchronous integration it's important to identify which message an asynchronous receipt is replying to. This script extracts the transaction's unique identifier.

In the case of an inbound create/update it would return their external message id (source id) to identify which transaction our asynchronous receipt belongs to. In the case of an inbound asynchronous receipt it would return our internal message id (target id) to identify which transaction their asynchronous receipt belongs to.

Your Inbound Settings form should look like this:

11) Click 'Save'.

We are now ready to configure the Fields for our CreateIncidentReceipt Message.