Webhooks

Webhooks

Webhooks

Introduction

Octeth comes with both inbound and outbound webhooks feature that gives you great flexibility and ease-of-integration with third party systems.

A webhook is an integration concept that’s getting more popular day by day. Webhooks are incredibly usefuly and a resource-light way to implement event actions.

So basically, a webhook is a way for an application to provide other applications with real-time information. A webhook delivers data to other applications as it happen.

Octeth has two types of webhooks:

  • Inbound webhooks which are used for accepting external data as it happens.
  • Outbound webhooks which are used for sending internal data as it happens to third party systems.

Let’s dive in to each one of these webhook types.

Inbound Webhooks

Octeth provides various new subscriber acquisition options to you.
Octeth provides various new subscriber acquisition options to you.

As shown in the diagram above, there are various ways of adding new subscriber to a mail list. You can use built-in subscribe forms, inject directly into the subscriber list MySQL database table, use the API or you can use inbound webhooks.

What makes inbound webhooks attractive is its resource-light way implementation. You don’t need to allocate development resources for API or MySQL integrations. Or you don’t need to get limited by using built-in subscribe forms.

Inbound webhook feature gives you great flexibility when it comes to integrating your subscriber lists into third party systems.

Whether you use third party lead generation forms, CRM systems, helpdesks, sales funnels, or your own systems, with a simple integration, you can start pushing subscriber data to your Octeth inbound webhooks. In a few seconds, you will make the integration.

Inbound webhooks can be configured in the User Area → Settings → Webhooks section. After logging into your user area, click “Settings” link and then click “Webhooks” link on the left side menu:

image

On the webhook management screen, if you have previously created webhooks, you will see the list of these webhooks along with their activity graphs.

In order to create a new inbound webhook, click “Create” link on the list toolbar and fill-in the form:

image

New Webhook Parameters

NameDescription
Name
Give a name to your inbound webhook. This is for administrative purpose, it’s not displayed publicly.
Target List
Choose the target subscriber list you would like to connect your inbound webhook to.
Event Type
Choose what kind of action to take when this inbound webhook event is trigged. It can be a subscription or an unsubscription event.

Once the webhook is created, you will be redirected to the inbound webhook integration guide:

Sensitive information on the screenshot is masked.
Sensitive information on the screenshot is masked.

As you can see above, Octeth gives you two different ways of using the inbound webhook. The secure way and the quick way.

The secure way is all about encrypting the inbound webhook data with a special AES-256-CBC algorithm. In this way, the encrypted data is not transferred as a plain data to the Octeth system. Octeth gives you an example PHP code snippet that shows you how to encrypt your inbound webhook data using a secret key and AES-256-CBC algorithm.

The quick way is all about adding your data into a webhook URL and executing it. This method doesn’t require any programming or encryption process and you can perform the integration in a matter of few seconds.

Along with the email adderess, you can pass any additional information to your subscriber custom fields. Octeth shows you the list of custom fields that can be used in your inbound webhooks at the end of the page. Simply add them to the inbound webhook payload as it is.

For example, in the above screenshot, the “First Name” is c3. If you want to pass the first name along with the email address of the subscriber, you must use the following approach:

...?email=test@test.com&c3=John

Inbound webhooks are the quickest and the easiest way of integrating your Octeth to any third party system such as Integromat, Zapier, Clickfunnels, or thousands of other systems.

Outbound Webhooks

When a specific event occurs in Octeth such as a subscription event or an unsubscription event, you can set specific webhook URLs to pass the event data to third party systems.

Outbound webhooks can be configured into separate sections in Octeth:

  • Journeys (automation)
  • List settings
ℹ️

In this article, we will cover setting up outbound webhooks in list settings. To learn more about Journeys and outbound webhook setup, please refer to this article.

On your [User Area → List Dashboard → Settings] section, scroll down and add the webhook URL to the “Web Service Integration” section:

image

Outbound webhooks in list settings can be set for “Subscription” or “Unsubscription” events. Once you add the new outbound webhook, it will be displayed in the list as shown below. You can always remove an outbound webhook by clicking “Remove” link next to it:

image

💠

image

Footer Social Icons

©Copyright Octeth, Inc. All rights reserved.