Conga Product Documentation

Welcome to the new doc site. Some of your old bookmarks will no longer work. Please use the search bar to find your desired topic.

Using Webhooks with Composer API

Below is an example of leveraging a webhook via Composer API request, using Postman.
  1. Import your JSON file into postman.
  2. Select your imported file and go to Authorization.
  3. Click the Get New Access Token to generate the Usertrust token.
  4. This will prompt the Conga for Advantage Platform login screen, select your IDP and input your login credentials.
  5. Logging in will prompt the notification to open Postman in browser. Click Open.
  6. The screen will display Authenticated.
  7. Open the Postman program. Click the Use Token Button to add it in the collection.
  8. After completing authentication click on IngressIbis Merge request. HIT POST endpoint: {{BASE_URL}}/api/ingress/v1/Merge?MergeEngine=PlatformComposer
    1. Payload:
      {
          "legacyOptions": {
              "SelectAttachments": "1",
              "DS7": "1",
              "DS7Preview": "1"
          },
          "templateSources": [
              {
                  "integrationName": "conga",
                  "fileId": "7097aeff-30f7-403c-9992-a967b2812b64"
              }
          ],
          "dataSources": [
              {
                  "type": "Webhook",
                  "dataSourceId": "3ab858b3-763f-441b-9825-cbd3b8e9f992"
              }
          ]
      }
    2. Output
      {
          "correlationId": "2cfe5f9d3bbc4fbe87265779f872cd44_DatasetJson",
          "status": "Accepted",
          "result": {
              "statusCode": "Success",
              "statusMessage": [
                  {
                      "code": "SUCC200",
                      "description": "Success"
                  }
              ]
          }
      }

You will receive a Correlation ID. For example, Correlation ID: 2cfe5f9d3bbc4fbe87265779f872cd44_DatasetJson

With the correlation ID, you can see preview and merge status. Hit GET API: GET: {{BASE_URL}}/api/ingress/v1/status/{{CORRELATION_ID}}?showDetails=true

To check preview, click Preview URL API with the correlation Id, which displays mergedFileUri-merged file type. GET: {{BASE_URL}}/api/ingress/v1/Merge/Preview/{{CORRELATION_ID}}?showDetails=true

You can use the Ctrl+Click keyboard shortcut on previewFileUri it will download the file to your local machine. You can Ctrl+Click on mergedFileUri to download the merged file.