Aysali APIInstall

Summary

Configure or retrieve the webhook settings for a specified Aysali API instance.

Inputs

• instanceName (required) — The name of the instance to configure or query.
• resourceForWebhook — Select whether to set a new webhook configuration ('setWebhook') or fetch the current webhook configuration ('findWebhook').
• enabled — Whether to enable or disable webhook integration when setting a webhook.
• webhookUrl — The target URL that will receive HTTP POST requests for webhook events.
• webhookByEvents — When enabled, appends the event name to the webhook URL path to create dedicated routes per event type.
• webhookBase64 — When enabled, includes media contents formatted as base64 strings inside webhook payloads.
• webhookEvents — List of specific events (such as MESSAGES_UPSERT, CONNECTION_UPDATE, CALL) that should trigger the webhook.

Output shape

a single record

Returns an object containing the response from the API, detailing the saved or fetched webhook configuration and status.

Examples

Example 1: Configure a new webhook endpoint for message updates

Instance Name: 'main-instance', Action: 'Set Webhook', Enable Webhook: true, Webhook URL: 'https://example.com/api/webhook', Events: ['MESSAGES_UPSERT', 'MESSAGES_UPDATE']

Example 2: Fetch current webhook details for an instance

Instance Name: 'main-instance', Action: 'Fetch Webhook'

Links

• n8n community nodes installation guide