Payload CMS

Interact with Payload CMS collections and globals
Join our community

Actions18

Overview

This node interacts with Payload CMS to perform various operations on collections, globals, and authentication-related actions. Specifically, for the 'Auth' resource and 'Forgot Password' operation, it sends a forgot password email to a user by making an authenticated POST request to the Payload CMS API endpoint for password recovery. This is useful in scenarios where users need to reset their passwords securely via email.

Use Case Examples

  1. Trigger a forgot password email to a user who has forgotten their login credentials.
  2. Integrate with Payload CMS to manage user authentication workflows including password recovery.

Properties

Name Meaning
Auth Collection The auth-enabled collection in Payload CMS where the user exists, e.g., 'users'.
Email The email address of the user who needs to receive the forgot password email.
Additional Options Optional parameters to customize the request such as depth of relationship population, pagination, sorting, filtering, field selection, and locale for localized content.

Output

JSON

  • json - The JSON response from the Payload CMS API, typically containing the result of the forgot password request or error details.

Dependencies

  • Requires an API key credential for Payload CMS to authenticate requests.

Troubleshooting

  • Common issues include authentication failures due to invalid or expired API credentials. Ensure the API key is valid and has appropriate permissions.
  • Errors may occur if the specified auth collection or email does not exist in Payload CMS. Verify the collection name and user email are correct.
  • Network or connectivity issues with the Payload CMS instance can cause request failures. Confirm the base URL and API prefix are correctly configured and the server is reachable.

Links

Discussion