List Tools - Online Help | Zoho Campaigns

List Tools

As the name suggests, list tools are additional options that can be used within lists. There are two tools:
  • List Key
  • Webhooks
You can access the list key by going to the Setup tab present inside a list. List Key is used in APIs of list management, where you can programmatically create data.

Webhooks is a feature that lets you collect real-time data or information from other applications and websites over the web.

You'll see in brief about these two tools below.

Use List Key for API

To use list management APIs, you need a mandatory parameter "listkey". The listkey represents the mailing list you're trying to access. The purpose of this key is to add contacts to a mailing list and is used to access the mailing list using API.

To view the list key for a list:

  1. From the Navigation Toolbar to the left, click Contacts and select Manage Lists.
  2. Click on the list for which you wish to view the list key.
  3. Click the Setup tab at the top.
  4. You can view the List Key. Click the Copy button to the right of the key to copy it for usage in APIs.


Webhooks

Zoho Campaigns introduce webhooks as a service that lets you collect information about the campaigns you send and also about the contacts in your lists. Zoho Campaigns provides two types of webhooks:
  • Contacts Webhook: This webhook allows you to keep track of contacts activities in your mailing lists such as subscribes, unsubscribes, and bounces.
  • Campaign Webhook: This webhook allows you to keep track of your campaigns' status from the time of campaign creation to delivery to its recipient.

Consider the following example. Steve has to send an important campaign to a specific list of contacts and generate certain insights from his campaign. There are three tasks that Steve needs to perform in order to generate data:

  1. Keep track of the campaign to make sure the campaign is sent successfully
  2. Make sure the campaign is sent to all the contacts in the list
  3. Identify if any contacts have left or newly joined the list

These are multiple tasks that usually take time if performed manually. Webhooks automates the manual tasks and sends you periodic updates of information in the event of the above actions taking place. So Steve can simply setup a URL in his application that would collect all the data he needs and notify him with the updated information.

Associate a Webhook

At some point, you may need to collect information across various lists of contacts and campaigns in your account. This can be accomplished by associating a webhook from one list to the webhooks of another list. You can also create new webhooks for the same list and associate them to the existing webhook to get more information. 

To associate a contact or campaign webhook follow the steps below:

     
  1. From the Navigation Toolbar to the left, choose Contacts.



  2. Click Manage Lists and select the list for which you want to associate a webhook.



  3. Click the More Actions button and select Webhooks.



  4. Click Associate.



  5. In the Associate Webhook pop up, enter the following information:


    1. Select an existing webhook of another list or add a new webhook.
    2. Select the action to be notified.



    3. Select who should perform those actions.
       6. Click Save.

You can associate multiple contact or campaign webhooks using the following steps: 
  1. From the Navigation Toolbar to the left, click Contacts.
  2. Click Manage Lists and select the list for which you want to associate a webhook.
  3. Click the More Actions button and select Webhooks.
  4. To associate Contact/Campaign Webhook, click Associate on the top-right corner of the row.



  5. In the Associate Webhook page, enter the following information:
    1. Select an existing webhook of another list or add a new webhook.
    2. Select the action to be notified.
    3. Select who should perform those actions.


       6. Click Save.

Disconnect a Webhook

You can disconnect a webhook connection from a specific list. However, the webhook will still exist in the webhook list page. There are two ways to disconnect a webhook:


  1. From the Navigation Toolbar to the left, click Contacts.
  2. Click Manage Lists and select the list in which you want to disconnect a webhook.
  3. Click the More Actions button and select Webhooks.
  4. Locate the webhook you want to disconnect from the list and click the Disconnect icon on the top-right corner.



Alternatively:
  1. From the Navigation Toolbar to the left, click Contacts.



  2. Click Manage Lists and select the list in which you want to disconnect a webhook.
  3. Click the More Actions button and select Webhooks.
  4. Locate the webhook you want to disconnect from the list and click the Reports icon.
  5. Click the View Details icon in the top-right corner and click the Disconnect icon.
  6. In the pop-up that appears, click Go Ahead.

Delete a Webhook

You can delete a webhook from a list and its associated lists in the Settings page.


  1. Click Settings (gear shaped icon) at top-right corner. 
  2. Click Webhooks under Developer Space.
  3. Locate the webhook you want to delete and click it.
  4. Click the Delete icon on the top-right corner of the details page. In the pop-up that appears, click Go Ahead. Once a webhook is deleted, it cannot be retrieved.


Reports

This section lets you view information about a webhook. You can Filter to view all or only failed or successful webhooks invoked in your lists. There are two ways to view reports:
  1. From the Navigation Toolbar to the left, click Contacts.
  2. Click Manage Lists and click the list for which you want to view the webhook reports.
  3. Click the More Actions button and select Webhooks.



  4. Locate the webhook and click the Reports  icon in the top-right corner.
Alternatively:
  1. Click Settings (gear shaped icon) at top-right corner.
  2. Click Webhooks under Developer Space.
  3. Click the webhook that you want to view reports for and select it.



  4. Click the Reports icon on the far right corner of the details page.

View Webhook Details

Webhook details let you view all the information affiliated with a webhook. You can edit a webhook, view reports and disconnect a webhook on this page. There are two places where you can view webhook details:
  1. From the Navigation Toolbar to the left, click Contacts.
  2. Click Manage Lists and click the list for which you want to view the webhook reports.
  3. Click the More Actions button and select Webhooks.



  4. Locate the webhook and click the Reports icon on the top-right corner.
  5. Click the View Details icon on the top-right corner of the reports page to view webhook details.
Alternatively: 
  1. Click Settings (gear shaped icon) at top-right corner.
  2. Click Webhooks under Developer Space.
  3. Click the webhook that you want to view reports for and select it. This page will display the details of the webhook.