Set up WHMCS

What you need

• A server on the premium plan, and to be one of its admins.
• A WHMCS you can reach over https from the internet. Addresses that are only reachable inside a network (for example localhost or a 192.168 address) cannot be used.
• API credentials for an admin in WHMCS, and that admin's role must have the API Access permission.
• WHMCS to accept calls from webticketer: either its address on WHMCS's API IP allow list, or an access key.

In WHMCS

1. Create API credentials

   In your WHMCS admin area, create API credentials for an admin (the menu is called API Credentials; its place differs between WHMCS versions). WHMCS gives you an identifier and a secret. Copy them now: WHMCS shows the secret once.

2. Give the credentials the right permissions

   The credentials act as a role. The role needs API Access and permission for the ticket actions (listing tickets, reading one, replying and updating) and for listing support departments. Nothing else is needed.

3. Allow webticketer to connect

   WHMCS only answers approved addresses. Under Setup, General Settings, Security add webticketer's address to the API IP allow list. If you cannot use an IP list, set an access key in WHMCS's configuration.php and enter it in the panel instead.

4. Choose who replies

   Pick an admin in WHMCS for the replies webticketer sends, for example a support account. Every reply from the panel appears in WHMCS from this admin, with the agent's name at the end of the text.

In the panel

1. Open the Integrations tab

   Go to Settings, Server settings, Integrations.

2. Fill in the card

   WHMCS address is where you open WHMCS, starting with https://. Enter the API identifier and API secret, the Access key only if you use one, and the username of the admin in Reply as this WHMCS admin. Press Save.

3. Press Test connection

   The panel asks WHMCS for its support departments. If that works you see how many there are, and a list of them appears so you can choose where their tickets go. If not, you see why (see WHMCS troubleshooting).

4. Choose a ticket type for each department

   Under Where each WHMCS department's tickets go pick, for each department, the ticket type its tickets are filed under (so they land in that type's panel queue). A department left on No type arrives with no type. Save again.

5. Switch it on

   Tick Pull in tickets from WHMCS and press Save. Within a minute the open tickets in WHMCS appear in the panel.

The card shows Connected with when it last checked, or the reason the last check failed. Credentials are saved encrypted and are never shown again: leave a box empty when you save to keep what is stored, and type a new value to replace it. Disconnect WHMCS deletes them.