Webhooks

 

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 in the application you are currently using. Every time these websites are updates with new information, you will receive a notification in the URL in your application. Therefore, allowing you to sit back and wait for information to reach you.

Why should you use Zoho Campaigns' Webhooks?

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

  • Subscriber Webhook: This webhook allows you to keep track of subscriber 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 subscribers and generate certain insights from his campaign. There are three tasks that Steve needs to perform in order to generate data:

  • Keep track of the campaign to make sure the campaign is sent successfully
  • Make sure the campaign is sent to all the subscribers in the list
  • Identify if any subscribers 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.

Generate a URL 

The first step in configuring a webhook is to provide a URL to which your requests will be delivered to. This URL would help post the data to the website you want. This is usually done on the backend or through APIs. You can obtain the URL from the application to which you want to post the data and paste it in Zoho Campaigns' Webhooks. 

Create a Webhook

Now that you understand why webhooks is used, learn how you can configure webhook in your Zoho Campaigns account from the below steps:

  1. From the Navigation toolbar, choose Settings and select Webhooks.
  2. Click Create and enter the following details during webhook creation:
    • A Name for your webhook
    • The URL of the webhook to be configured from the application to which you want your data to be posted to.
    • The Method to extract data (i.e., POST or GET)
    • The number of Calls per Hour (The default is 60 for free users)
  3. Click Save .

You can also create more webhooks using the steps below:

  1. From the Navigation toolbar, choose Subscribers.
  2. Select Manage Lists and select the list that you want to add a webhook for.
  3. Click the More tab and select Webhooks.
  4. Click Associate.
  5. On the Associate Webhook page, click Add Webhook from the dropdown.
  6. Enter the following details during webhook creation:
    • A Name for your webhook
    • The URL of the webhook to be configured from the application to which you want your data to be posted to.
    • The Method to extract data (i.e., POST or GET)
    • The number of Calls per Hour (The default is 60 for free users)
    • The Actions to trigger a call
  7. If you are creating a subscriber webhook, choose who carries out the actions and set the Entity Parameters to be sent as data.
  8. Click Create.

Associate a Webhook

At some point, you may need to collect information across various lists of subscribers 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 subscriber or campaign webhook follow the steps below:

  1. From the Navigation toolbar, choose Subscribers.
  2. Select Manage Lists and select the list for which you want to add a webhook.
  3. Click the More tab and select Webhooks.
  4. Click Associate.
  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 Done.

You can associate more webhooks using the following steps:

  1. From the Navigation toolbar, choose Subscribers.
  2. Select Manage Lists and select the list for which you want to add a webhook.
  3. Click the More tab and select Webhooks.
  4. To associate Subscriber/Campaign Webhook, click Associate on the top-right corner of the row.
  5. In the Associate Webhook page, 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 Done.

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, choose Subscribers.
  2. Select Manage Lists and 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 Disconnect icon on the top-right corner.

Alternatively:

  1. From the Navigation toolbar, choose Subscribers.
  2. Select Manage Lists and select the list from which you want to disconnect a webhook.
  3. Click the More tab and select Webhooks.
  4. Locate the webhook you want to disconnect from the list and click the Logs icon.
  5. Click the View Details icon in the top-right corner and click the Disconnect icon.

Delete 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 and select Webhooks.
  2. Locate the webhook you want to delete and select it.
  3. Click the Delete icon on the top-right corner of the details page.

View 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, choose Subscribers.
  2. Select Manage Lists and select the list that you want to view the webhook logs for.
  3. Click the More tab and select Webhooks.
  4. Locate the webhook and click the Logs icon in the top-right corner.

Alternatively:

  1. From the Navigation toolbar, choose Settings and select Webhooks.
  2. Locate the webhook that you want to view logs for and select it.
  3. Click the Logs 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, choose Subscribers.
  2. Select Manage Lists and select the list for which you want to view the webhook logs.
  3. Click the More tab 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. From the Navigation toolbar, choose Settings and select Webhooks.
  2. From the list of webhooks displayed, click on the webhook for which you want to view details.

Share this post : FacebookTwitter

Still can't find what you're looking for?

Write to us: support@zohocampaigns.com