HostBill icon

HostBill

Consume HostBill API (v.0.1.3)

Actions39

Overview

This n8n node allows you to create a new client in HostBill via its API. It is designed for scenarios where you need to automate the onboarding of new clients, such as when integrating sign-up forms, CRM systems, or other business processes with your HostBill instance. For example, you could use this node to automatically add a new client whenever a user registers on your website or when a new customer is added to your sales pipeline.

Properties

Name Type Meaning
First name String The client's first name. Required.
Last name String The client's last name. Required.
Email String The client's email address. Required.
Password String The password for the client account. Required.
Confirm Password String Confirmation of the password (should match the Password field). Required.
Additional Fields Collection Optional fields for further client details, such as notification preferences, type, language, company info, contact details, and address.
  Notify Client Boolean Whether to send login details to the client. Optional.
  Type Options Client type: "Private" or "Company". Optional.
  Language String Default language for the client. Optional.
  Company Name String Company name if applicable. Optional.
  Phone Number String Client's phone number. Optional.
  Address Line 1 String First line of the address. Optional.
  Address Line 2 String Second line of the address. Optional.
  City String City of residence. Optional.
  State String State or region. Optional.
  Post Code String Postal code. Optional.
  Country String Country. Optional.
Privileges Collection Set of boolean flags controlling the client's permissions and access within HostBill.
  Billing: Receive billing notifications Boolean Allow receiving billing emails. Optional.
  Billing: Allow to view/pay invoices Boolean Allow viewing and paying invoices. Optional.
  Billing: Place new orders Boolean Allow placing new orders. Optional.
  Billing: View current balance Boolean Allow viewing current balance. Optional.
  Billing: Add funds Boolean Allow adding funds. Optional.
  Billing: Creditcard Boolean Allow managing credit cards. Optional.
  Support: Open new tickets Boolean Allow opening support tickets. Optional.
  Support: View current tickets Boolean Allow viewing support tickets. Optional.
  Support: Close tickets Boolean Allow closing support tickets. Optional.
  Support: Receive email notifications Boolean Allow receiving support emails. Optional.
  Misc: Modify main profile details Boolean Allow editing main profile. Optional.
  Misc: View emails history Boolean Allow viewing email history. Optional.
  Misc: Edit security settings Boolean Allow editing security settings. Optional.
  Misc: Add / Edit contacts Boolean Allow managing contacts. Optional.
  Misc: Access affiliates section Boolean Allow accessing affiliate section. Optional.

Output

  • The node returns an array of JSON objects, each representing the result of a client creation attempt.
  • On success, each object contains the data returned by the HostBill API for the newly created client.
  • If an error occurs and "Continue On Fail" is enabled, the output will include an object with an error property containing the error message.

Example output (success):

[
  {
    "id": 123,
    "firstname": "John",
    "lastname": "Doe",
    "email": "[email protected]",
    // ...other fields returned by HostBill...
  }
]

Example output (failure with Continue On Fail):

[
  {
    "error": "Email address already exists"
  }
]

Dependencies

  • HostBill API: Requires a valid HostBill API endpoint and credentials.
  • n8n Credentials: You must configure the hostBillApi credential in n8n.
  • Environment Variables: None specified, but your HostBill instance must be accessible from the n8n environment.

Troubleshooting

  • Common Issues:

    • Missing required fields (e.g., First name, Last name, Email, Password, Confirm Password).
    • Password and Confirm Password do not match.
    • Email address already exists in HostBill.
    • Invalid or missing HostBill API credentials.
    • Network issues preventing connection to HostBill.

  • Error Messages:

    • "Email address already exists": The provided email is already registered. Use a unique email.
    • "Invalid credentials": Check your HostBill API credentials in n8n.
    • "Missing required parameter: [field]": Ensure all required fields are filled.
    • "Network error": Verify that n8n can reach your HostBill server.

Links and References

Discussion