New Evolution APIInstall

Summary

Configure or verify AWS SQS integration settings for an Evolution API instance by enabling/disabling SQS, providing AWS credentials, region, queue URL, and selecting event types.

Inputs

• Instance Name or ID (required) — Select or specify the Evolution API instance by name or ID to configure or check SQS integration.
• O Que Deseja Fazer (required) — Choose whether to 'Definir SQS' (set/configure SQS) or 'Verificar SQS' (check existing SQS configuration).
• Ativar SQS — Enable or disable the SQS integration when setting it.
• Access Key ID (required) — Your AWS Access Key ID for SQS access (required when setting SQS).
• Secret Access Key (required) — Your AWS Secret Access Key for SQS access (required when setting SQS).
• Região (required) — The AWS region for the SQS queue, e.g. 'us-east-1' (required when setting SQS).
• URL Da Fila (required) — The full URL of the AWS SQS queue to integrate (required when setting SQS).
• Eventos — Select one or more event types to integrate with SQS, such as CALL, CONNECTION_UPDATE, MESSAGES_UPDATE, MESSAGES_UPSERT, SEND_MESSAGE (used when setting SQS).

Output shape

a JSON object with the result of the set or check SQS operation

The response JSON reflects success, failure, or the current configuration of the SQS integration for the specified Evolution API instance. Setting requires all AWS and queue information; checking does not require AWS credentials.

Examples

Example 1: Configure SQS integration

Set SQS with AWS keys, region, queue URL, enabled state, and desired event types for an Evolution API instance.

Example 2: Verify current SQS setup

Query the current SQS integration configuration for a specific Evolution API instance by selecting 'Verificar SQS' (findSqs) operation.