Actions20
- Claim (Case Management API) Actions
- Debtor (Case Management API) Actions
- Info (Case Management API) Actions
- Company (Partner API) Actions
- User (Partner API) Actions
- User Invite (Partner API) Actions
Overview
This node integrates with the Paywise API, specifically allowing interaction with various resources including user invites via the Partner API. The "User Invite" resource with the "Get" operation enables retrieving detailed information about a specific user invite by its ID. This is useful in scenarios where you need to verify the status or details of an invitation sent to a user, for example, to confirm if an invite has been accepted or to fetch metadata related to that invite.
Practical examples:
- Fetching the details of a pending user invite to display in an admin dashboard.
- Verifying the existence and status of a user invite before resending it.
- Auditing user invites for compliance or reporting purposes.
Properties
| Name | Meaning |
|---|---|
| User Invite ID | The unique identifier of the user invite to retrieve. This is required to specify which invite's details to fetch. |
Output
The output is an array of JSON objects, each representing the data returned from the Paywise API for the requested user invite. The structure of the json output field corresponds directly to the user invite details as provided by the Paywise Partner API. It typically includes fields such as invite ID, email, status, creation date, expiration, and other metadata related to the invite.
No binary data output is indicated for this operation.
Dependencies
- Requires an API key credential for authenticating with the Paywise API.
- The node depends on the Paywise Partner API being accessible and properly configured.
- No additional environment variables are explicitly required beyond the API authentication setup.
Troubleshooting
Common issues:
- Providing an invalid or non-existent User Invite ID will likely result in an error or empty response.
- Network connectivity problems or incorrect API credentials can cause authentication failures.
- Selecting a resource or operation not implemented will throw an error indicating the missing implementation.
Error messages:
"Resource \"userinvite\" is not implemented": Indicates the selected resource is not supported; ensure the resource name is correct."Operation \"get\" for resource \"userinvite\" is not implemented": Means the operation is not available for the resource; verify operation spelling and availability.- API errors related to authorization or invalid IDs will be passed through from the Paywise API and should be handled accordingly.
Links and References
- Paywise API Documentation – Official documentation for all Paywise API endpoints and usage guidelines.