Skip to main content
Skip table of contents

REST API Callback


The REST API Callback system integration enables you to send asynchronous REST API requests. Callbacks enable you to receive data at a specified callback URL when a particular event is triggered. Asynchronous processing of callbacks ensures that your application can continue running without waiting for a response from the server, leading to faster and more efficient communication.

REST API Callback is available for use in:





Deployment Options

Option I, Option II, Option III, Option IV


  1. Log in to D3 SOAR.

  2. Find the REST API Callback integration.

    1. Navigate to Configuration on the top header menu.

    2. Click on the Integration icon on the left sidebar.

    3. Type REST API Callback in the search box to find the integration, then click it to select it.

    4. Click + Connection, on the right side of the Connections section. A new connection window will appear.

  3. Configure the following fields to create a connection to REST API Callback.

    1. Connection Name: The desired name for the connection.

    2. Site: Specifies the site to use the integration connection. Use the drop-down menu to select the site. The Share to Internal Sites option enables all sites defined as internal sites to use the connection. Selecting a specific site will only enable that site to use the connection.

    3. Recipient site for events from connections Shared to Internal Sites: This field appears if you selected Share to Internal Sites for Site to let you select the internal site to deploy the integration connection.

    4. Agent Name (Optional): Specifies the proxy agent required to build the connection. Use the dropdown menu to select the proxy agent from a list of previously configured proxy agents.

    5. Description (Optional): Add your desired description for the connection.

    6. Configure User Permissions: Defines which users have access to the connection.

    7. Active: Check the tick box to ensure the connection is available for use.

    8. REST API: This section contains the parameters defined specifically for the integration. These parameters must be configured to create the integration connection.
      1. Input the Request URL.
      2. Select an authentication method.

      1. Basic Authentication:
        i. Input your User Name.
        ii. Input your password.

      2. Bearer Authentication:
        i. Input your Bearer Token. For more information about bearer tokens, see OAuth 2.0 Bearer Token Usage.

    9. Enable Password Vault: An optional feature that allows users to take the stored credentials from their own password vault. Please refer to the password vault connection guide if needed.

  4. Test the connection.

    1. Click Test Connection to verify the account credentials and network connection. If the Test Connection Passed alert window appears, the test connection is successful. You will see Passed with a green checkmark appear beside the Test Connection button. If the test connection fails, please check your connection parameters and try again.

    2. Click OK to close the alert window.

    3. Click + Add to create and add the configured connection.

  5. (Optional) Add custom connection parameters.

    1. Click + Connection Parameter, and select the desired parameter type.

    2. Define your parameters. The defined parameter name will be used in your commands. If you wish to encrypt your data, select the Is sensitive data option before clicking on Add.

    3. Once you have defined your parameters, you can locate them under the corresponding parameter type when building your connection. For instance, if you created a custom parameter, it will be found under the Custom parameters section.

    4. Repeat the above steps, including defining your custom parameters, as needed. Finally, repeat steps 3 and 4 to create and add your connector.


Send Request

Sends a REST API request.

Reader Note

By default, {{connector.[connector's parameter name]}} is the format used for inputs received from the connection, including encrypted data.

To create custom connection parameters, refer to step 5 of the Connection guide. Once you define the values within the current connector, you can apply them as the command parameter value. For example, if you create a custom parameter named "DOC Test" and want to call this value in the Body parameter, input {{connector.DOC_TEST}} (where "DOC_TEST" is the parameter name).


Input Parameter






The URL of the REST API request typically defines the desired resource or endpoint for the operation. If a complete URL is provided, it will be used directly. Otherwise, the connector combines the provided URL with the request URL to create a complete URL. By default, this parameter uses the connector using the request URL. To use any other connector data, you must follow the format {{connector.[connector's parameter name]}}.




The HTTP method used for initiating the request.




The request header typically defines the metadata and other information about the request. To use the connector data, you must follow the format {{connector.[connector's parameter name]}}.


"d3key": "{{connector.restapi_bearertoken}}"




The request body is a JSON object containing the request's relevant data. To use the connector data, you must follow the format {{connector.[connector's parameter name]}}.


Error Handling

If the Return Data is Failed, an Error tab will appear in the Test Result window.

The error tab contains the details responded from D3 SOAR or third-party API calls, including Failure Indicator, Status Code, and Message. This can help you locate the root cause of a command failure.

Parts in Error



Failure Indicator

Indicates the command failure that happened at a specific input and/or API call.

Send Request failed.

Status Code

The response code issued by the third-party API server or the D3 SOAR system that can be used to locate the corresponding error category. For example, if the returned status code is 401, the selected connection is unauthorized to run the command. The user or system support would need to check the permission setting in the Rest Api CallBack portal. Refer to the HTTP Status Code Registry for details.

Status Code: 500.


The raw data or captured key error message from the integration API server about the API request failure.

Message: Internal Server Error.

Error Sample Data

Send Request failed.

Status Code: 500.

Message: Internal Server Error.

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.