The Basics of Integrations

Bárbara Ramos Updated by Bárbara Ramos

Integration via API

Integration is the action to search, modify or send information to a service. The integrations are divided into two:

  • Native: The Weni platform can integrate with APIs that have REST/Json format through a Webhook card or through a pre-existing application in the Integrations menu.
  • Non-native: We do non-native integrations for APIs that are not REST/Json. However, in this case, we must analyze the effort and scope of the request, since we use external services to consume and model the API, for example Back4app and Pipedream.

What is API?

It is a form of communication between systems, in which one of them provides information and services that can be used by the other (Weni Platform). Typically an API has:

  • Url
  • Documentation explaining how it can be used
  • Available endpoints/features;
  • Authentication forms to use the API, if necessary.

What is Webhook?

Webhook is a technology used to allow communication between two applications in real time. At Weni Plataforma we can search and even update information in other systems through the Chamar Webhook card.

To pass information to a system using API you must use the body of the request (body) or pass it directly in the URL (query). The API documentation will tell you how to do this.

In this image we can see the documentation of Weni's API:

In this image we can see how the request body would look:

How to know if the API can be integrated natively?

The API documentation works as a manual that helps us understand how to integrate. It will inform you if the requests are in the native architecture of the Weni platform: REST/Json.

If your API architecture is not REST/Json, it is still possible to integrate, but you will need to model this API.

How to view API call on Weni platform?

To view the API return, access the Webhooks log in the Flows Module:

Have more questions about API? Play in our community ­čśë We have an expert team to answer your questions.

How did we do?

Native ChatGPT Integration