Callback Profiles

Callback profiles are used to trigger the endpoints and receive callback data for the configured callback event. You can create the Callback Profiles using the HTTP methods, GET and POST. Use the Callback Profiles page, to create new callback profiles and to edit the existing ones.

Create a Callback profile

To create a callback profile:

  1. Navigate to Settings. The Setting page appears.
  2. Click Callback Profiles. The Callback Profiles page appears.
  3. Click Create New.
13681368
  1. In the Name field, enter the name of the Callback profile.
  2. From the HTTP Method dropdown list, select the required method.
13681368
  1. Based on the selection, do the following:

HTTP Method

Steps

GET

  1. Enter the URL to trigger.
  2. Enter the required headers as a key/value pair.

POST

  1. Enter the URL to trigger.
  2. Enter the required headers as a key/value pair.
  3. Provide the body in any one of the four body types—XML, JSON, HTML, or Text.
13681368 13681368
  1. Click the Enable Encryption toggle button. The fields related to encryption are displayed.

📘

Note

  1. Enter the following details to enable encryption:

Field

Description

Algorithm

Select the required algorithm from the list:

  • AES-128-CFB
  • AES-128-GCM
  • AES-192-CFB
  • AES-192-GCM
  • AES-256-CFB
  • AES-256-GCM

Note:
- GCM (Galois counter mode)—GCM encryption algorithm combines two modes; the counter mode and the new Galois mode of authentication. The parallel computation enabled in the latest mode ensures higher speed encryption with higher throughput than other encryption algorithms like CFB.
- CFB (Ciphertext feedback)—CFB algorithms can only be parallelized in the decryption process and not in the encryption process, therefore they run with a slower performance than other algorithms such as those in mode GCM.

Key

Enter a unique secret key to be passed along the algorithm for encryption.

Note:
The length of the key is dependent on the algorithm selected, the options are:
- AES-128 (Length will be 16 characters)
- AES-192 (Length will be 24 characters)
- AES-256 (Length will be 32 characters)

Initialization Vector

Enter the initialization vector of 16 characters.

Note:

  • Initialization Vector is used to prevent a sequence of text that are identical from generating the same ciphertext when encrypted.
  • This is a mandatory factor.

Parameters

Enter the parameters to be encrypted.

13681368
  1. Click Save. The saved profiles are listed on the Callback Profile page. You can filter the data on the listing page with Callback Profile Name, HTTP Method, and Created Date range for accurate results.

📘

Note:

Each Callback profile created has a unique ID (as shown in the following image) that is used in the APIs to trigger the callback.

13681368

Did this page help you?