Asaas icon

Asaas

Integração com a API do Asaas para pagamentos e cobranças
Join our community

Actions29

Overview

This node integrates with the Asaas API to manage webhooks and other payment-related resources. Specifically, for the Webhook - Get Many operation, it retrieves a list of webhooks configured in the Asaas system. This is useful when you want to programmatically fetch all webhook configurations, for example, to audit existing webhooks, synchronize them with another system, or display them in a dashboard.

Practical examples:

  • Fetching all webhooks to verify which events your system is subscribed to.
  • Automating the management of webhook URLs and their settings.
  • Integrating webhook data into reporting or monitoring workflows.

Properties

Name Meaning
Limite Maximum number of webhook results to return (minimum 1). Defaults to 50.

Output

The output is an array of JSON objects, each representing a webhook retrieved from the Asaas API. Each object contains the webhook's details such as its ID, name, URL, subscribed events, status, and other configuration parameters.

Example structure of one webhook item (fields may vary):

{
  "id": "string",
  "name": "string",
  "url": "string",
  "email": "string",
  "events": ["event1", "event2"],
  "sendType": "SEQUENTIALLY" | "PARALLEL",
  "apiVersion": 3,
  "enabled": true,
  "interrupted": false,
  "authToken": "string"
}

No binary data output is produced by this operation.

Dependencies

  • Requires an API key credential for authenticating with the Asaas API.
  • The node uses the Asaas REST API v3 endpoints.
  • The base URL depends on the environment selected in credentials (sandbox or production).
  • No additional external services are required beyond the Asaas API.

Troubleshooting

  • Package Unavailability Error:
    If the node throws an error indicating the package was removed from npm, it means the underlying integration package is no longer available. The message suggests removing the node from your installation.

  • Invalid API Key or Authentication Errors:
    Ensure that the API key credential is correctly configured and has the necessary permissions to access webhook data.

  • Limit Parameter Issues:
    The limit property must be at least 1. Setting it below this will likely cause an error.

  • Network or Timeout Errors:
    Check network connectivity and ensure the Asaas API endpoint is reachable.

Links and References

Discussion