AvantGuard - WebhookSite icon

AvantGuard - WebhookSite

AvantGuard - WebhookSite

Actions100

Overview

This node operation "Kickoff Procedure By Id" initiates or starts a specific procedure identified by its unique ID. It is useful in automation workflows where you need to programmatically trigger predefined procedures, such as starting maintenance tasks, business processes, or any custom workflow defined as a procedure in the connected system.

Practical examples include:

  • Automatically kicking off a maintenance procedure for a piece of equipment when certain conditions are met.
  • Starting an onboarding process for a new employee by triggering the relevant procedure.
  • Initiating a quality check procedure on a product batch once it reaches a certain stage in production.

Properties

Name Meaning
Id The unique numeric identifier of the procedure to be started.
Additional Query Parameters Optional parameters to customize the kickoff request:
- Asset Id Numeric ID of an asset to associate with the procedure kickoff (optional).
- Name A new name to assign to the procedure instance being kicked off (optional).

Output

The node outputs JSON data representing the response from the procedure kickoff API call. This typically includes details about the initiated procedure instance, such as its status, identifiers, timestamps, and any metadata returned by the service.

If the node supports binary data output, it would represent related files or attachments linked to the procedure kickoff, but this is not indicated in the provided code snippet.

Dependencies

  • Requires an API key or authentication token configured in n8n credentials to authorize requests to the external service managing procedures.
  • Depends on the external API endpoint that handles procedure kickoffs, which must be accessible via the base URL set in the node's credentials.
  • Uses query parameters to pass optional data like asset association and renaming.

Troubleshooting

  • Common issues:

    • Providing an invalid or non-existent procedure ID will likely result in an error response from the API.
    • Missing or incorrect API credentials can cause authentication failures.
    • Network connectivity problems may prevent the node from reaching the external service.
  • Error messages:

    • "Procedure not found" or similar indicates the specified ID does not exist; verify the ID value.
    • Authentication errors suggest checking the API key or token configuration.
    • Timeout or connection errors require ensuring network access and correct base URL.

Links and References

  • Refer to the external API documentation for the procedure management system to understand the full capabilities and parameters of the kickoff endpoint.
  • n8n documentation on how to configure API credentials and use HTTP request nodes for similar integrations.

Discussion