Webhooks

Reporting Webhook Configuration

This document provides detailed instructions for configuring the Reporting Webhook within your contract creation, signing, and payment system. This webhook allows real-time updates and notifications based on specified triggers and conditions.

Accessing the Webhook Configuration

To configure the Reporting Webhook, follow these steps:

1. Navigate to Dashboard -> Configurations -> Connectors.

2. Click Create New Connector and select Reporting.

3. From the list, choose Webhook and click Next. You will be presented with the webhook configuration page.

Webhook Configuration Settings

The webhook configuration page contains several settings that you need to fill out. Below is a detailed description of each setting:

Business Units (Required)

Select the Business Units to which this configuration will be linked. This is a mandatory field.

Triggers (Required)

Select the triggers that will activate the webhook. You can choose multiple triggers from the following options:

• Create: Triggered when the transaction (contract) is created.

• Update: Triggered when the transaction (contract) is updated.

• Send: Triggered when the transaction (contract) email is sent to the recipient client.

• Review: Triggered when the transaction (contract) is reviewed by someone through the checkout.

• Expired: Triggered when the transaction (contract) expires.

Payload URL (Required)

Enter the Webhook URL where the payload will be sent. This is a mandatory field.

Content Type (Required)

Select the content type for the payload. This is a mandatory field. The available options are:

• application/json

• application/x-www-form-urlencoded

Secret (Optional)

Enter a secret value that will be used to authorize the Webhook call using basic authentication. This field is optional.

SSL Verification (Required)

Select the SSL verification option. This is a mandatory field and contains the following options:

• Enable SSL verification (default)

• Disable SSL verification

This setting determines if SSL verification is required when making HTTP or HTTPS requests.

Data to Receive (Required)

Select the type of data you want the webhook to receive. This is a mandatory field and contains the following options:

• Only Update Status

• Send me everything (default)

Choose whether to receive only the status update of the contract or all the data of the contract along with the status.

Assignments Fields (Optional)

Provide an array of field names that define which extra field data to report for each company that belongs to the Business Units. This field is optional.

Data Field Mapping (Optional)

Provide an array of field names that define how each field in the transaction (contract) is mapped to the properties in the pushback report. This field is optional.

Example Configuration

Here is an example of how to fill out the configuration:

• Business Units: Provider BU

• Triggers: create, update, send

• Payload URL: https://example.com/webhook

• Content-Type: application/json

• Secret: your_secret_key

• SSL Verification: Enable SSL verification

• Data to Receive: Send me everything

By following these steps and filling out the configuration settings as described, you can successfully set up the Reporting Webhook to meet your specific needs.

For further assistance or troubleshooting, please refer to the support documentation or contact our support team.