Payhawk icon

Payhawk

Interact with the Zitadel API

Actions99

Overview

This node operation allows you to add a member to an account team within the Payhawk system. It is useful for managing team memberships by programmatically assigning users to specific teams and defining their roles within those teams. Typical use cases include automating team management workflows, onboarding new users into teams with predefined roles, or synchronizing team membership from external systems.

For example, when a new employee joins a company, this node can be used to automatically add them to the appropriate account team in Payhawk and assign the necessary roles, ensuring they have the correct permissions without manual intervention.

Properties

Name Meaning
Account Id Identifier of the account to which the team belongs.
Team Id Identifier of the team to which the member will be added.
Member Id User ID of the member in Payhawk who will be added to the team.
Roles JSON array specifying the roles granted to the team member (e.g., ["admin", "viewer"]).

Output

The node outputs JSON data representing the result of the "Add Member To A Team" operation. This typically includes confirmation details such as the updated team membership information or status messages indicating success or failure. The exact structure depends on the API response but generally contains fields related to the member's addition to the team and assigned roles.

No binary data output is expected from this operation.

Dependencies

  • Requires an API key credential for authenticating requests to the Payhawk API.
  • The node uses the Payhawk API base URL configured in the credentials.
  • Proper network access to the Payhawk API endpoint is necessary.

Troubleshooting

  • Common issues:

    • Invalid or missing Account Id, Team Id, or Member Id can cause request failures.
    • Incorrectly formatted Roles JSON may lead to parsing errors.
    • Insufficient permissions of the API key might prevent adding members to teams.
    • Network connectivity problems can cause timeouts or unreachable API errors.
  • Error messages and resolutions:

    • "Member not found": Verify that the Member Id corresponds to an existing user in Payhawk.
    • "Team not found": Check that the Team Id is correct and exists under the specified Account Id.
    • "Invalid roles format": Ensure the Roles property is valid JSON and matches expected role names.
    • Authentication errors: Confirm that the API key credential is correctly set up and has required scopes.

Links and References

Discussion