Authentication and Security Requirements

Basic Authentication

Your endpoint must accept an Authorization header in the following format: Authorization: Basic <base64(username:password)>

The username and password should be configured in your appsettings.json file under WebhookSettings.BasicAuth.

{
"Logging": {
"LogLevel": {
"Default": "Information",
"Microsoft.AspNetCore": "Warning"
}
},
"AllowedHosts": "*",
"WebhookSettings": {
"HmacSecretKey": "your-hmac-key",
"BasicAuth": {
"Username": "your-username (ClientId)",
"Password": "your-password (ClientSecret)"
}
}
}

• Username: The Client ID you received from Conga when creating your webhook.

• Password: The Client Secret you received from Conga when creating your webhook.

Endpoints

Get a List of Webhooks:

GET /api/webhooks/v1

Purpose: Returns a list of all webooks for an authenticated org.

webhookId, name, events, status, createdAt

Get a Single webhook:

GET /api/webhooks/v1/{webhookId}

Purpose: returns the details of a specific Webhook, indicated by its ID value.

Returns: 404 error message if the webhook is not found in the authenticated org.

Update a Webhook:

PATCH /api/webhooks/v1/{webhookId}

url, events, authentication, name

{
"isSuccess": true,
"statusCode": 200,
"message": "Webhook updated successfully.",
"data": {
"id": "d8d30cb0-5675-4bd2-8ae3-b49f96d899c9",
"name": "WebhookUpdate",
"url": "https://8h0tskxn-7078.inc1.devtunnels.ms/api/event/webhook1",
}
}

Returns: Upon success, the updated webhook will be returned, or 404 error message if not found in the org.

Delete a Webhook

DELETE /api/webhooks/v1/{webhookId}

Purpose: Removes the specified webhook.

Returns: 204 on a success, 404 if not found. Subsequent delete attempts on the same ID will result in 404 errors.

{
"name": "WebhookName",
"endpointpath": "https://webhook.site/54321",
"requestBody":
"event": "DataRequest",
"datasetId": "12345",
"timestamp": "2025-09-17T14:15:22.123Z"
}

Retrieving Customer Data -

GET /customer

Purpose: Retrieve specified customer data

Requirements:

• Validate Basic Auth

[
{
"date": "2025-09-17T14:15:22.123Z",
"json": "{ \"id\": 1, \"name\": \"Customer 1\" }"
}
]

POST /customer

Purpose: Process customer data

Requirements:

• Validate Basic Auth

• Accept request body in the required CustomerRequest structure

public class CustomerRequest
{
public string Event { get; set; } = string.Empty;
public string DatasetId { get; set; } = string.Empty;
public string Timestamp { get; set; } = string.Empty;
}

{
"event": "DataRequest",
"datasetId": "12345",
"timestamp": "2025-09-17T14:15:22.123Z"
}

public class CustomerData
{
public string Date { get; set; } = string.Empty;
public string Json { get; set; }
}

[
{
"date": "2025-09-17T14:15:22.123Z",
"json": "{ \"id\": 1, \"name\": \"Customer 1\", \"city\": \"City1\" }"
}
]

Step 1: Acquire a Webhook URL

1. Enter the endpoint of a third-party CRM, for example Webhook.site.

2. Click the Edit button.

3. Change "Content type" to application/json.

4. In Content, paste in your JSON values and click Save.

5. Your unique webhook URL will generate.

6. Copy this value and pasty this to a text document.

Step 2: Create Webhook value in Platform

1. Navigate to Conga Advantage Platform.

2. In the Apps list, go to Automation > Webhooks.

3. Click the + New button to create a new webhook listing.

4. Click into the New Webhook name to edit the name.

5. Select Post/GET as the method.

6. Click into the "Enter the URL to get started" field and copy and paste the webhook URL from the end of step 1.

7. Click the Authentication tab and input your Client ID and Secret values.

   Note: You can store up to 100 secret keys per Conga Platform org. This includes webhooks, Composer API client IDs and secrets and other Composer Platform IDs and secrets.

8. Under the Headers tab, input the Key and Values fields. Click the small green checkmark when you are done to add it to the list of Headers.

9. Click Save.

Step 3: Merge with the Document

1. On the Webhook Management page, copy the Webhook ID of your desired webhook by clicking the copy button.

2. Navigate to Document Merge > Document Selection.

3. In your browser URL, ensure the type is equal to Webhook, and paste the Webhook ID in the dataSourceID. Example: congacloud.io/app/merge?type=Webhook&dataSourceid=ccda0cb6-b7f4-aac7-e9odd4335ese7a

Now select one of your existing templates and click Generate & Preview.