How can I set up webhooks

How can I set up webhooks

Webhooks let you collect real-time data from other applications and websites over the web. The websites that you need information from are hooked to a URL, which is set up in the application you are currently using.  
 
Every time these websites are updated with new information, you will receive a notification in the webhook URL of your application.  This allows you to sit back and wait for the information to reach you.
 
Zoho MarketingHub allows you to configure webhooks for your mailing lists and campaigns. You can extract real-time data, including subscribes, unsubscribes, date, and time a campaign was sent or delivered. Configure the time interval that you want to get update in, and set the data you require as parameters while creating a webhook.
 
In this guide, we'll walk you through the steps to create, associate, disconnect, and, delete webhooks.  We'll also look at the privileges associated with webhooks, reports, and details.
 

Privileges associated with webhooks

To perform different operations related to webhooks, you need have the relevant privileges in the Webhooks module.

Why should you use webhooks? 

Zoho MarketingHub features webhooks as a service that lets you collect information about the campaigns you send and also about the leads in your lists.  MarketingHub provides two types of webhooks:

  • Lead webhook: This webhook allows you to track lead activities in your mailing lists, such as subscribes, unsubscribes, and bounces.
  • Campaign webhook: This webhook allows you to track your campaigns' status from the time of campaign creation to delivery to its recipient.

    • Use case

    Steve has to send an important campaign to a specific list of leads and generate certain insights from this campaign. There are three tasks that Steve needs to perform to generate data:

  • Track the campaign to make sure it is sent successfully
  • Make sure the campaign is sent to all the leads in the list
  • Identify if any leads have left or newly joined the list
    •  

    These multiple tasks usually take time when performed manually. Webhooks automate the manual tasks and send a periodic update about any of the above mentioned actions that have taken place. Steve can simply provide a webhook URL in his application to collect all the data he needs, and sends him periodic updates.

    Generate a URL 

    The first step in configuring a webhook is to provide a URL that your requests will be delivered to. This URL will help post the data to the website of your choice. This is usually done on the backend or through APIs. You can obtain the URL from the application that you want to post the data to, and paste it in Marketing Hub's webhook.

    Creating a webhook 

    Learn how you can configure webhook in your MarketingHub account from the below steps: 

    1.  From the Navigation toolbar, choose Settings.

    2. Select Webhooks under Developer space.


    3. Choose either Lead webhook or Campaign webhook and click Create.



    4. a. Enter the following details during Lead webhook creation:
    • A Name for your webhook
    • The URL of the webhook to be configured from the application that you want your data to be posted to.
    • The Method to extract data (such as POST or GET)
    • The number of calls per hour (The default is 60 for free users)
    • URL parameters of data that, you might require in your webhook feed.

    5.a. Click Save.



                                                                       
      OR
    4. b. Enter the following details during Campaign webhook creation:
    • A Name for your webhook
    • The URL of the webhook to be configured from the application that you want your data to be posted to.
    • The Method to extract data (such as POST or GET)
    • The number of calls per hour (The default is 60 for free users)

    5.b. Click Save.


     

    The information returned by a webhook will look like this:

     

    Associating a webhook

    At some point, you may need to collect information across various lists of leads and campaigns in your account. This can be accomplished by associating a webhook from one list with the webhooks of another list. You can also create new webhooks for the same list and associate them with an existing webhook to get more information.  
    To associate a lead or campaign webhook follow the steps below:
     

    1. From the Navigation toolbar, choose Leads.

    2. Select List Management, then open the list that you want to add a webhook for.

    3. Click More icon and select Webhooks.


    4. Click Associate under lead webhook or campaign webhook.

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

    • Select an existing webhook of another list or add a new webhook.
    • Select the action to be notified.
    • Select who should perform those actions.

    6. Click Save.


    Disconnecting a webhook

    You can disconnect a webhook connection from a specific list. However, the webhook will still exist in the webhook list page. 

    1. From the Navigation toolbar, choose Leads.

    2. Select List Management, then open the list that you want to add a webhook for.

    3. Click the More icon and select Webhooks.


    4. Locate the webhook you want to disconnect from the list and click the Disconnect icon in the top-right corner.


    Alternatively:

    1. From the Navigation toolbar, choose Leads.

    2. Select Manage Lists, then select the list that you want to disconnect a webhook from.

    3. Click the More tab 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.


    Deleting a Webhook

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

    1. From the Navigation toolbar, choose Settings.

    2. Select Webhooks under Developer space.


    3. Locate the webhook you want to delete and select it.


    4. Click the Delete icon in the top-right corner of the details page.


    Viewing 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. You can follow the below steps to view reports: 

    1. From the Navigation toolbar, choose Settings.

    2. Select Webhooks under Developer space.


    3. Locate the webhook that you want to view logs for and select it.


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


    Viewing 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. You can view webhook details by following these steps,

    1. From the Navigation toolbar, choose Settings.

    2. Select Webhooks under Developer Space.


    3. From the list of webhooks displayed, click on the webhook that you want to view the details of.






    Next steps

    To configure callback URL and get exclusive notifications about all unsubscribes, click here.

      • Related Articles

      • Webhooks

        Webhook is a developer-friendly module that facilitates automated HTTP notifications to third party applications from Zoho Projects. Using Webhooks , you can configure your own HTTP URLs and associate them to specific business rules in order to ...

      • Webhooks

        A webhook is a HTTP callback or push API that automatically sends real time notifications to third party applications. These notifications are sent when you perform a set of events. You can access webhooks only if you are on the professional plan. ...

      • Webhooks

        Webhooks facilitates communication with third-party applications by sending instant web notifications every time an event occurs in Zoho Recruit. With Webhooks, you can configure HTTP URLs and associate them in workflow rules to automate the entire ...

      • Webhooks

        Webhooks facilitates communication with third-party applications by sending instant web notifications every time an event occurs in Zoho Workerly. With Webhooks, you can configure HTTP URLs and associate them in workflow rules to automate the entire ...

      • How to create webhooks

        Webhooks is a feature that lets you collect real-time data or information from other applications and websites over the web. This feature is simple and easy to implement. The websites that you need information from are hooked to a URL which is setup ...