Webhooks

This guide covers the steps in setting up webhooks within the Convirza platform, detailing how to configure them to send call data to a specific endpoint.

Webhooks can send call data in real time to an endpoint of your choosing. To set a webhook, follow the steps below:
Part 1: Setting Up the Webhook

Steps to Configure a Webhook

1. Log In to Your Convirza Account:
    Navigate to Settings → Customization →                         Webhook.
    Create a New Webhook:
   Click the Create button.
2. Fill Out the Required Fields  
   Endpoint URL: Enter the URL where the call data will be sent. 
    (Example: Use a test endpoint for testing, such as those available by searching "webhook test site" on            Google).
3. Test Your Webhook:
   Click Test Webhook to verify functionality. Data should be received at your endpoint within seconds.
4. Add Static Parameters (Optional):
   If your endpoint requires basic authentication or custom payloads, fill in the Field Name and Static Value fields.
5. View Associated Tracking Numbers:
   Webhooks can inherit numbers from parent groups if added at the top or second level. Numbers and number pools linked to the webhook are listed under the Associated Tracking Numbers tabs.

If a webhook is added to the top-level or second-level group, it will be inherited by the subgroups.

Part 2: Adding the Webhook to Tracking Numbers

Overview

Webhooks must be added to tracking numbers for data transmission. There are two types of webhooks:

1. Post-Call Webhooks: Triggered after call completion.

1. Pre-Call Webhooks: Triggered at the start of a call.

Post-call webhooks are triggered immediately after a call is completed and can be configured to activate only when specific conditions are met. These webhooks can include additional data such as the caller's name and address, indicator scores (if you utilize Conversation Analytics), and DNI logs (if you're using DNI). You can easily include these data points by checking the appropriate boxes in the screenshot provided.

On the other hand, pre-call webhooks are activated at the start of a call and are sent for all calls. You can also include DNI logs by selecting the option to ‘Include DNI logs’ in the screenshot.

While post-call webhooks can transmit more data points, pre-call webhooks have the advantage of being sent as soon as a call connects. This can be particularly useful if you want to identify which campaign a caller is being referred from right at the beginning of the call.

Post Call Webhooks

Post-call webhooks are ideal for detailed data transmission, including caller details, indicator scores, and DNI logs.

Steps to Add a Post-Call Webhook:

1. Navigate to the Tracking Number Settings:
   1. Go to Reports → Tracking Number Settings.
   2. Click the link under the TN Name column.
2. Access Conversation Actions:
   1. Click the Notification button.
3. Set Conditions:
   1. Choose a condition for triggering the webhook (e.g., "All calls over 0 seconds").
4. Select the Webhook:
   1. In the Trigger Webhook action, select the webhook you created.
5. Save Changes:
   1. Click Save to finalize the configuration.

Pre Call Webhooks

Pre-call webhooks provide immediate data transmission as soon as the call connects. They are ideal for identifying campaigns at call start.

Steps to Add a Pre-Call Webhook:

1. Navigate to the Tracking Number Settings:
   1. Go to Reports → Tracking Number Settings.
   2. Click the link under the TN Name column.
2. Expand Advanced Tracking Number Settings:
   1. Click the plus symbol to expand settings.
3. Enable Pre-Call Webhook:
   1. Check the box for Pre-call webhook.
   2. Select an existing webhook from the dropdown or click Create to set up a new one.
4. Save Changes:
   1. Click Save to apply the configuration.

Key Considerations

1. Post-Call Webhooks:
   1. Provide more data points such as caller name, address, and DNI logs.
   2. Best for in-depth post-call analysis.
2. Pre-Call Webhooks:
   1. Send data as soon as the call connects.
   2. Useful for identifying the referring campaign at call initiation.