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

• 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

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.
   

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.
   
   
   

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.
   
   
   
   
   

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

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.
   

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

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.
   

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.