One way of authenticating a webhook call is by including a key generated by you, as part of the webhook URL. For example, the URL could look like:

https://server.yourcompany.com/tcbiz-webhook?key=<yourkey>

Feature-set

Payload - Call Me Back

{
  "event_id": "91584c0f-32a8-11ef-a9e4-5a5798f0",
  "client_account_id": "9b7f9343-12a5-4271-b560-6daa163",
  "event_type": "cmb",
  "created_at": "1719288504",
  "cmb_payload": {
    "business_number": "0806951XXXX",
    "feature_set": "cmb",
    "client_number": "08047360",
    "requested_at": "1719288504",
    "requested_date": "26 June 2024",
    "requested_slot": "tomorrow"
  }
}

Payload - User Feedback

{
  "event_id": "d9f0c752-32a8-11ef-af53-3e643cc47",
  "client_account_id": "9b7f9343-12a5-4271-b560-6daa1638",
  "event_type": "user_feedback",
  "created_at": "1719288626",
  "survey_payload": {
    "business_number": "080698XXXXXX",
    "feature_set": "user_feedback_numbers",
    "client_number": "0804736XXXX",
    "requested_at": "1719288626",
    "user_responses": [
      {
        "question": "Did you find our services helpful?",
        "response": "Yes, very helpful!"
      }
    ]
  }
}

Number groups

Payload - Call Me Back

{
    "event_id": "15502265-74a2-4df7-a810-7b262d827",
    "client_account_id": "11f288fa-9e83-4aa5-968b-28df7ca53",
    "event_type": "cmb",
    "created_at": "1711709529734",
    "cmb_payload": {
        "business_number": "9190357XXXX",
        "number_group": "Capital City - sales",
        "client_number": "+91901906XXXX",
        "requested_at": "1711709529734",
        "requested_date": "30 Mar 2024",
        "requested_slot": "Saturday"
    }
}

Payload - User Feedback

{
  "event_id": "8140e293-c8e0-4102-bed4-5553c94f",
  "client_account_id": "11f288fa-9e83-4aa5-968b-28df7ca53",
  "event_type": "user_feedback",
  "created_at": "1711709820631",
  "survey_payload": {
    "name": "webhook_survey ",
    "business_number": "+91903571XXXX",
    "number_group": "Capital City - Support numbers",
    "client_number": "+9190190XXXXX",
    "user_responses": [
      {
        "question": "Did you find our support response helpful?",
        "response": "Yes, somewhat helpful."
      }
    ]
  }
}

Whenever there is a response to the enabled features you have set up with a webhook, we will catch it as an event. Right now, we are all set to capture Call Me Back and User Feedback events.

A webhook can be attached to one or both of the Call Me Back and User Feedback events.

Event logs for your webhooks can be found from Manage Webhooks page or Webhook events page.

In order to notify your systems for events related to features in your enterprise plan, Webhooks (or HTTP callbacks) can be configured on the Self-serve platform.

We support Call Me Back and User Feedback events for webhooks. Each event has its resources that can be referred from the resource column.

1. To configure your webhooks, click on the overflow menu and click on "Manage Webhooks".

2. Click on “Create webhook” to add a new webhook.

3. Add the name of the webhook in the field provided. The name should not exceed 50 characters.

4. Add the webhook URL.

5. Select the type of webhook event (Call Me Back or User Feedback), as per your requirement.

6. Once all details have been filled, click on "Create". Your wehook has now been created.

7. You can click on "Test Webhook" to test the webhook you have created for a particular event.

A webhook can only be tested after it is created. Below are the steps to test a Webhook:

1. Click on Test Webhook on an existing webhook.

2. Choose the event to test (The current default selection is Call Me Back).

3. Click on Test URL.

To change a webhook’s configuration or to delete it, click on the overflow menu beside the Test webhook button.

There are 3 timeouts for Webhooks provided by Truecaller for Business:

1. Connection Timeout: The connection timeout is the timeout for making the initial connection to the webhook URL's HTTP server.

2. Read Timeout: Once the initial connection has been made, there is a possibility that there is an indefinite wait to read data from the HTTP server at any time. The read timeout is the timeout for such a wait.

3. Total Webhook Timeout: In addition to the above timeouts, Truecaller for Business also checks the total execution of time of any webhook call via the webhook execution timeout.

The values for each timeout are as follows:

Webhook execution can fail due to timeouts or errors. For each event where webhook call fails, the calls are retried up to 7 times based on the following schedules:

This is mentioned in the event details page.

There are 3 error scenarios for webhooks:

1. Webhook not found

2. Events:

   • Rescheduled error

   • Webhook Deleted

3. Webhook Failed: When webhook fails an email is sent to the user.