Call Webhook: Making requests to external services

Matheus Enrique Alves Updated by Matheus Enrique Alves

What is an API?

The acronym API corresponds to “Application Programming Interface“. They are a way of integrating systems, enabling benefits such as data security and ease of exchanging information.

Today, the ability to connect and integrate with other systems is an essential feature for most solutions today. For this reason, we have an action card to use in flows precisely for this function: Call Webhook

Call Webhook

The Call Webhook card is responsible for the connection between the platform and other external systems, below, we have a little about her anatomy:

  1. Request method: Where you define what will be the method for your API request (GET, POST, PUT or DELETE);
  2. Request URL: Where you place the request URL for the API;
  3. Request header: Where you place the request header along with information such as authorization tokens and content types;
  4. Request body: Where you add a body for your request (used for POST and PUT);

How to format the request body correctly

Normally, for the POST and PUT requests body we use JSON notation to send the information requested by the API. Below is an example of a JSON body:

{"platform": "push", "author": "john"}

How can we reproduce this notation using the webhook call card? On the platform, we use the functions @json and @object for this construction, the first to signal which notation we will translate the values, and the second to signal the beginning and end of our keys. Translating the example above to the notation used on the platform, we have:

@(json (object ("platform", "push", "author", "john")))

If you want to use a variable such as @contact.name for the "author" field in our example, we have:

@(json (object ("platform", "push", "author", contact.name)))

The request body accepts all variables and expressions supported on the platform.

How did we do?

Decision cards

Split by Intent: Using Classifiers

Contact