Skip to main content

Sending Data for Analysis via Webhooks

  • Updated

Index:

  1. Pre-requisites
  2. Testing
  3. Registering a Webhook
  4. Types of Sending
  5. OAuth 2.0
  6. Custom Headers

If you wish to access the data generated by your bot in other analysis tools, you can configure Webhooks to make this information available outside of Blip.

When configuring a Webhook, all message, event, and contact information traffic on the platform will be sent to the URLs defined for your bot.

Attention: If a large number of consecutive failures are detected in sending the same type of data (contacts, events, messages, or tickets), the integration will be blocked for 4 hours. More details here.

 

Pre-requisites

To use this integration, you need a service with a public URL set up to receive HTTPS POST requests with JSON objects in the body of the request. We recommend responding to the submissions with an HTTP 200 OK status code.
In many use cases, it is common to develop a simple API that captures these submissions and redirects them to the final destination (database, data lake, or other systems).
See here for more details about the format of the submissions.

 

Testing

If you don't yet have an API implemented to receive Blip's submissions, you can use third-party tools available online to test the reception and analyze the data format.

Some examples:

Note: These tools are not meant to be a final solution, and Blip has no relation to them.

 

Registering a Webhook

  1. Access the Blip portal, select your bot, and go to the Integrations module.
  2. Choose the Webhook option.

  1. In Settings, add at least one URL to receive the information sent by Blip.
  2. Make sure to activate the key in the top right corner.

The webhook uses a queue system, where the data is queued for immediate sending right after its generation. During high-traffic periods, the processing of submissions may take longer, up to around 2 hours.

Advanced Settings

Optionally, you can configure advanced options for each registered URL, allowing you to customize the sending according to your needs:

Note: Changes to these settings may take a few minutes to take effect due to caching.

 

Types of Sending

You don't need to receive all the types of information generated by Blip in the same URL if you don't want to. You can select whether you want to receive only Contacts, Events, Messages, or Tickets (coming soon).
This feature also allows you to separate a specific URL for each type of item, making it easier to process and organize the data.

OAuth 2.0

OAuth 2.0 is an authorization standard that allows you to protect the registered URL without exposing sensitive credentials.
Currently, we support the Client Credentials flow, which is used for server-to-server authentication.

 

Custom Headers

The keys and values registered here are added as headers in the HTTPS request. They can be used to send arbitrary values useful for your API or to implement a simple authentication system, in case OAuth 2.0 is not the best option.

For more information, visit the discussion on this topic in our community or the videos on our channel. 😃

Related articles