AvantGuard - ConnectSecure icon

AvantGuard - ConnectSecure

AvantGuard - ConnectSecure
Join our community

Actions223

Overview

This node operation, Post Create Company Mapping under the Integration resource, is designed to create a company mapping by sending a POST request to an external API. It allows users to specify a user ID via a header and optionally include additional JSON data in the request body. This node is useful for integrating with systems that require company mapping configurations, such as syncing company data between platforms or setting up integration rules programmatically.

Practical Examples

  • Automating the creation of company mappings when onboarding new clients.
  • Syncing company configuration settings from one system to another.
  • Managing notification and consent settings related to company integrations.

Properties

Name Meaning
X USER ID The user identifier sent as a required HTTP header (X-USER-ID) to authenticate or identify the user.
Additional Body Fields Optional JSON fields to customize the request body. Includes: no_notification, enable_notification, consent_enabled, configuration, and integration_rules. These control notification preferences, consent settings, configuration flags, and integration rules respectively.

The Additional Body Fields property accepts a JSON object with these default keys and values:

{
  "no_notification": false,
  "enable_notification": false,
  "consent_enabled": false,
  "configuration": false,
  "integration_rules": "[]"
}

Users can modify this JSON to tailor the company mapping creation request.

Output

The node outputs the response from the API call in the json field of the output data. This typically contains the details of the created company mapping or any relevant confirmation or error messages returned by the API.

If the API supports binary data responses, it would be handled accordingly, but based on the provided code and properties, the primary output is JSON data representing the result of the POST request.

Dependencies

  • Requires an API key credential (or similar authentication token) configured in n8n to authorize requests to the external service.
  • The base URL for the API is set via credentials.
  • Uses the @avantguardllc/n8n-openapi-node package and an OpenAPI specification (openapi.json) bundled with the node for request building and validation.

Troubleshooting

  • Missing or invalid X USER ID header: The API may reject requests without a valid user ID header. Ensure this property is set correctly.
  • Malformed JSON in Additional Body Fields: If the JSON is not well-formed, the request will fail. Use proper JSON syntax.
  • API authentication errors: Verify that the API key or authentication token is correctly configured in the node credentials.
  • Unexpected API errors: Check the API response message for details; ensure the endpoint URL and request format match the API specification.

Links and References

Discussion