DirectusInstall

Overview

The Directus Webhooks - Get operation node retrieves detailed information about a specific webhook from a Directus instance using its primary key (ID). This is useful for automating the management and monitoring of webhooks configured in your Directus project. For example, you might use this node to fetch webhook details for auditing, troubleshooting, or integrating webhook metadata into other workflows.

Practical scenarios:

• Fetching webhook configuration details for documentation or compliance.
• Validating that a webhook exists and is correctly set up before triggering related automation.
• Integrating webhook data with other systems for monitoring or reporting.

---

Properties

Name	Type	Meaning
ID	String	Primary key of the webhook to retrieve. This uniquely identifies the webhook in Directus.

---

Output

• The output will be a single item with a json field containing the webhook's details as returned by the Directus API.
• The structure of the output depends on the Directus version and webhook configuration, but typically includes fields such as:
  • id: The unique identifier of the webhook.
  • name: The name of the webhook.
  • url: The endpoint URL the webhook calls.
  • actions: The actions/events that trigger the webhook.
  • collections: The collections associated with the webhook.
  • Other metadata fields relevant to the webhook.

Example output:

{
  "id": "15",
  "name": "Order Created",
  "url": "https://example.com/webhook",
  "actions": ["create"],
  "collections": ["orders"],
  // ...other webhook properties
}

• If the response is not an object, it will be wrapped as { "response": <value> }.
• If the result is a primitive value (string, number, boolean), it will be wrapped as { "result": <value> }.

---

Dependencies

• Directus API: Requires access to a running Directus instance.
• API Credentials: You must configure the directusApi credentials in n8n for authentication.

---

Troubleshooting

Common issues:

• Invalid ID: If the provided ID does not correspond to any webhook, the node may return an error or an empty result.
• Authentication errors: If the API credentials are missing or incorrect, you may receive authentication/authorization errors.
• Network issues: Connectivity problems between n8n and the Directus server can cause request failures.

Error messages and resolutions:

• "error": "Request failed with status code 404": The webhook with the specified ID does not exist. Double-check the ID.
• "error": "Unauthorized": Check your Directus API credentials in n8n.
• "error": "<network error>": Ensure the Directus instance is reachable from your n8n environment.

---

Links and References

• Directus Webhooks Documentation
• n8n Directus Node Documentation
• Directus API Reference