1. Configuring the Evolution Instance
To configure an instance in the Evolution Channel, you need to access the/instance/create
route of the Evolution API with the following request body:
Creating the Instance
EndpointRequest Body Parameters
instanceName
: Name of the instance you are creating.token
: Optional token to authenticate the instance.number
: Number ID of the instance that will be used to receive and send messages.qrcode
: Set tofalse
because the integration does not require a QR Code.integration
: Use"EVOLUTION"
to specify that this integration is with the universal Evolution channel.
2. Message Input in the Evolution Channel
After creating the instance, the Evolution Channel will receive the messages sent to the configured instance. These messages are sent to the{baseUrl}/webhook/evolution
route as POST requests. This is the entry point for messages that the Evolution Channel will process.
Webhook URL for Message Input
Example of Message Input Payload
Here is an example of the payload format sent to the Evolution Channel when a message is received:Explanation of Payload Fields
numberId
: ID of the number registered when creating the instance.key.remoteJid
: Number or unique ID of the contact who sent the message.key.fromMe
: Indicates whether the message was sent by the contact (false
) or by the system itself (true
).key.id
: Unique ID of the message.pushName
: Name of the contact who sent the message.message.conversation
: Content of the received message.messageType
: Type of message (in this case,conversation
).
3. Feedback and Postbacks
The Evolution Channel sends feedback and postbacks through configured event channels such as webhooks, RabbitMQ, or SQS. This allows you to receive real-time notifications about the status of messages and interactions, keeping your system up to date. Examples of Event Channels- Webhook: Notifications are sent to a specified HTTP endpoint.
- RabbitMQ: Messages are sent to a configured RabbitMQ queue.
- SQS: Messages are sent to an AWS SQS queue.