AvantGuard - WebhookSite icon

AvantGuard - WebhookSite

AvantGuard - WebhookSite

Actions100

Overview

This node operation creates a new list resource by sending a request to an external API. It is useful in scenarios where you want to programmatically generate and manage lists, such as task lists, contact groups, or any collection of items that your workflow needs to organize dynamically. For example, you could use this node to create a shopping list with predefined items or a mailing list for a marketing campaign.

Properties

Name Meaning
Additional Body Fields Optional JSON fields to include in the request body when creating the list. This can be used to specify the list items or other attributes. The value should be a JSON object, for example:
json { "list_items_attributes": [ { "name": "item1" }, { "name": "item2" }, { "name": "item3" } ] }

Output

The output contains a json field representing the response from the API after creating the list. This typically includes details about the newly created list such as its ID, name, and the items it contains. If the API supports binary data output (e.g., attachments or files related to the list), it would be included accordingly, but based on the provided code, only JSON response data is expected.

Dependencies

  • Requires an API key credential or similar authentication token configured in n8n to authorize requests to the external service.
  • The node uses a base URL and headers set from credentials, so proper configuration of these credentials is necessary.
  • Depends on the external API described by the bundled OpenAPI specification (openapi.json) for the list creation endpoint.

Troubleshooting

  • Invalid JSON in Additional Body Fields: If the JSON provided in the "Additional Body Fields" property is malformed, the node will fail to parse it, resulting in an error. Ensure the JSON syntax is correct.
  • Authentication Errors: Missing or incorrect API credentials will cause authorization failures. Verify that the API key or token is correctly set up in the node credentials.
  • API Endpoint Issues: If the base URL or endpoint path is misconfigured, the request may fail. Confirm the API base URL in the credentials matches the target service.
  • Empty or Missing Required Fields: If required fields for list creation are omitted, the API might reject the request. Make sure to provide all mandatory data either through the main properties or additional body fields.

Links and References

  • Refer to the external API documentation for detailed information on the list creation endpoint and supported request body parameters.
  • JSON formatting guides can help ensure the "Additional Body Fields" input is valid.

Discussion