Notificações Inteligentes icon

Notificações Inteligentes

NI Integration
Join our community

Actions48

Overview

This node operation "Get Integration" retrieves details about a specific integration by its ID. It is useful when you want to fetch the current configuration or metadata of an existing integration within your system. For example, you might use this node to:

  • Display integration details in a dashboard.
  • Verify the existence and properties of an integration before performing updates.
  • Retrieve related information such as available events or checklist items associated with the integration.

Properties

Name Meaning
ID The unique identifier of the existing integration to retrieve. This is a required field.
Include Relationships Optional properties to include in the response. Options: "Available Events", "Checklist".
  • ID: A string representing the integration's unique ID.
  • Include Relationships: Allows including additional related data in the response, such as:
    • Available Events: Events that the integration can handle.
    • Checklist: Checklist items associated with the integration.

Output

The output JSON contains the detailed information of the requested integration. If the "Include Relationships" property is used, the response will also include nested fields for those relationships (e.g., lists of available events or checklist items).

The structure typically includes:

  • Integration core properties (like ID, name, status).
  • Optionally, arrays or objects representing related entities such as events or checklists.

No binary data output is indicated for this operation.

Dependencies

  • Requires access to the external API endpoint at https://api.notificacoesinteligentes.com to fetch integration data.
  • An API authentication token or key credential is necessary to authorize requests to this service.
  • The node uses HTTP GET requests with query parameters to specify included relationships.

Troubleshooting

  • Invalid or missing ID: If the provided integration ID does not exist or is empty, the node may return an error or empty response. Ensure the ID is correct and non-empty.
  • Authentication errors: Failure to provide valid API credentials will result in authorization errors. Verify that the API key or token is correctly configured.
  • Timeouts or network issues: The node sets a timeout of 5 seconds for requests. Network delays or unavailability of the external API may cause timeouts. Check network connectivity and API status.
  • Incorrect "Include Relationships" values: Using unsupported options in the "Include Relationships" field may lead to unexpected responses or ignored parameters. Use only the documented options.

Links and References

Discussion