Put topics about this connector package here.
Always check the ‘How to use the Alumio connector packages’ topic.
Extra information
Connector package documentation:
System documentation:
Connector Package Documentation
Table of Contents
1 Setting up HTTP Client Whatsapp. 2
2 Subscribing to Entities from Whatsapp. 2
2.2 Select the Whatsapp HTTP Client to use. General Concept. 2
3 Publishing Entity to Whatsapp. 5
Setting up HTTP Client Whatsapp
Steps
- In Alumio Dashboard, go to Clients > HTTPS Client. Create a new HTTP Client and select Whatsapp HTTP Client as the prototype of the HTTP Client.
- Fill in the Bearer Token according to your Whatsapp Cloud API Account.
- Press Save Button on the Top-Right.
Subscribing to Entities from WhatsApp
Steps
- Go to Connections → Incoming and create a new incoming configuration and select Whatsapp Subscriber as the subscriber.
- Select the Entity you want to subscribe to from WhatsApp.
- Add any request parameters needed to subscribe to the entity.
- You can optionally add a transformer to transform the request parameters into something you need.
Select the WhatsApp HTTP Client to use. General Concept
We follow WhatsApp documentation on building this connector so you can easily use the connector based on WhatsApp API Reference.
Entity
It’s the entity you want to subscribe from WhatsApp. Please refer to the entities in Management APIs from the WhatsApp API Reference page.
Request Parameters
These are the parameters you can provide to get the needed entity based on WhatsApp API Reference. Please look at the example below on how to fill the Request Parameters field when subscribing Single Request entity
That’s why we need to define the PHONE_NUMBER_ID property inside the path property in the Request Parameters field. The properties inside query parameters will be parsed as query parameters. Here is the final URL that will be called when using such a Request Parameters field.
/xxxx/whatsapp_business_profile
Input Transformer
Any transformers set here will be executed after the Request Parameters are loaded. So, you basically can add any transformer to provide and transform the request parameters into anything you need either as path parameters and/or as query parameters of an entity.
HTTP Client
It’s the HTTP Client configuration or prototype you will use to access WhatsApp.
Publishing Entity to Whatsapp
Steps
- Go to Connections → Outgoing, create a new outgoing configuration, and select Whatsapp Publisher as the publisher.
- Select the action that you want the publisher to do with the data.
- Select the Whatsapp entity you want the data to be published to.
- Select the HTTP Client to use.
General Concept
Like the subscriber, the publisher has similar methods on how to use it. The difference is the payload that will be submitted by the publisher originating from the data (from routes, from transformers in outgoing configuration).
Method
Currently, we support POST, PUT, and DELETE methods for submitting data to Whatsapp Cloud API.
Entity
We support publishing to most Whatsapp endpoints but not with publishing binary files at the moment. Please refer to the entities in Management APIs from the Whatsapp API Reference page. Based on the documentation, some endpoints may need one or more path parameters.
For endpoints that require object as the request payload, please look at the example below. For example, we want to Send Messages. Please select “POST” as the action and “Messages - Send” as the entity of the publisher.
You can put the payload you want to send to WhatsApp into the payload property in the data. Here is an example of the Possible Response after Creation.
Alumio will send an API request to Whatsapp with URL /xxxx/messages
HTTP Client
It’s the HTTP Client configuration or prototype you will use to access WhatsApp.