How can we help?

Search

How to Create Webhooks for PJA

Brian
Brian
  • Updated

Purpose: 

To Give a definition of webhooks and how they can be used in Allbound.

 

Overview

Webhooks (Web Callback, HTTP Push API or Reverse API) are one way that a web application can send information to another application in real-time when a specific event happens.

Example:

Suppose a customer wants to be notified every time a user registers a deal where the deal region is EMEA then you can setup a PJA with these conditions and configure a webhook to send specific information to the application as a POST, GET (HTTP) Request.

 

Webhooks vs Open APIs

Unlike api calls, webhooks are asynchronous. In case of an Open API the system has to keep calling api to look and pull for changes, in case of webhooks the changes in the source system are pushed to the target system on a defined URI.

 

How Allbound Uses Webhooks

Allbound uses webhooks to notify via customers’ application when an event happens in the customer account. Allbound uses Partner Journey Automation to create automated workflows which can track events in the system based on configured filters. A successfully triggered workflow can be notified to end users via - email, zapier and webhook. Webhooks are particularly useful for asynchronous events like when a user registers a deal or a new user has registered in the system, or when a user has completed a training.

How To Setup a Webhook

 

1. Add an Action of type Webhook in Partner Journey Automation

Create a workflow in Partner Journey Automation with desired configuration and choose the Action(Choice of Notification) as Webhook

 

 

2. Choose Action Event Type

This is the request method type which is supported by your endpoint. 

  • POST

The POST method submits an entity to the specified resource, often causing a change in state or side effects on the server.

  • GET

The GET method requests a representation of the specified resource. Requests using GET should only retrieve data.

PUT

The PUT method replaces all current representations of the target resource with the request payload.

 

3. Specify the Webhook URL

This is the URL Endpoint configured at the external application’s end which will be called by Allbound Application to notify for the workflow configured. 

 

4. Data

The data is the payload in a key value format which will serve as input to the custom application endpoint. This data can be configured in Allbound specific to the event you have configured. You can use merge tags to pick up specific fields from the event notification which will be sent out to the target application.

 

 

The request payload data which will be sent to the endpoint can consist of any number of key value pair data. The value may be static string or tags chosen from a dropdown corresponding to the event occurred. One can also send the entire data payload in a single key and then process the data independently at the custom application’s end.

 

5. Authentication

Currently the application supports Basic Authentication.

 

6. Headers

The application endpoint may be expecting certain header keys like Content-Type, Authorization, etc. You can specify any number of Headers that the application expects while calling this endpoint api.

 

Merge Tags

Allbound uses an amazing feature to dynamically configure merge tags as keys to identify specific fields from a data set. You can use these fields while configuring your payload in webhooks data which will be enriched to the actual value when the event is fired. 

 

Test Your Trigger

After configuring the webhook trigger, Users can use the provided Test button which will send a call to the endpoint to test the integration of webhook

 

 

If you still have questions, please reach out to your Customer Success Manager or Open a Support Ticket.

 

Also, please refer to these articles to further learn about Partner Journey Automation:

Was this article helpful?

1 out of 1 found this helpful

Have more questions? Submit a request