ZAppwrite icon

ZAppwrite

Use Appwrite's API from inside N8N, updated by @ZachHandley

Overview

The node integrates with Appwrite's Messaging API to list logs related to a specific messaging provider. This operation is useful for monitoring and auditing message delivery, troubleshooting issues, or analyzing message traffic associated with a particular provider.

A practical example: If you manage multiple messaging providers (e.g., email, SMS, push notifications) in your Appwrite project, you can use this node operation to retrieve logs for a selected provider to check message statuses, errors, or usage patterns.

Properties

Name Meaning
Provider ID The unique identifier of the messaging provider whose logs you want to list. You can generate a random ID using unique() or provide a custom ID.
Additional Fields A collection of optional query filters to refine the log results. These include queries that filter by attributes such as BCC, CC, draft status, enabled status, sender email/name, HTML content flag, scheduled time, targets, topics, and users. Queries support operations like equal, greater than, less than, limit, offset, order ascending/descending, not equal, and search.

Output

The output is a JSON array containing the logs of the specified messaging provider. Each log entry typically includes details about messages sent through the provider, their status, timestamps, and any relevant metadata.

The node does not output binary data for this operation.

Dependencies

  • Requires an active connection to an Appwrite server.
  • Requires credentials including the Appwrite API URL, project ID, and an API key credential with permissions to access messaging provider logs.
  • No additional environment variables are needed beyond the configured credentials.

Troubleshooting

  • Common Issues:

    • Invalid or missing Provider ID: Ensure the Provider ID is correct and exists in your Appwrite project.
    • Insufficient permissions: The API key used must have rights to read messaging provider logs.
    • Network or connectivity problems: Verify the Appwrite endpoint URL and network accessibility.
  • Error Messages:

    • "Resource not found": This indicates the specified resource or operation is invalid; verify you selected the correct Resource ("Messaging") and Operation ("List Provider Logs").
    • API authentication errors: Check that the API key credential is valid and has appropriate scopes.
    • Empty results: Could mean no logs exist for the given provider or filters applied exclude all entries.

Links and References

Discussion