Views:

Learn how to create an API application in HaloPSA and obtain the credentials required for integration with external services.

Important
Important
The following HaloPSA instructions were valid as of November 17, 2025. For further help, check your HaloPSA documentation.

Procedure

  1. Navigate to HaloPSA API settings.
    1. Sign into your HaloPSA instance with an Administrator account.
    2. Go to Configuration → Integrations → HaloPSA API.
      V1xSP_HaloPSA_1=e08b6cff-8551-4b9f-b8a9-09e673aa7a6c.png
    3. Click View Applications to view any existing API applications.
      V1xSP_HaloPSA_2=30b6fbe9-61ab-4b23-b5fe-d83d054008e7.png
  2. Create a new API application.
    1. Click New to create a new API application.
      V1xSP_HaloPSA_3=dbc0568b-4b10-4d5e-b488-b79b1a175a27.png
    2. Configure general settings for the application.
      V1xSP_HaloPSA_4=721107ac-d154-4fdc-9aaa-feef37b75d21.png
      Field
      Setting
      Application Name
      Provide a descriptive name for your application.
      Active
      Make sure the Active check box is selected.
      Authentication Method
      Select Client ID and Secret (Services).
      Login Type
      Select Agent.
      Agent to log in as
      Select the agent account you created for this integration.
      Important
      Important
      Note down the generated Client ID and Client Secret and store these credentials securely. These credentials are crucial for authentication and will not be visible again after saving.
      If you forget the Client Secret, you must generate a new one. Generating a new Client Secret stops the old one from working.
  3. Configure and assign necessary API permissions.
    1. Click the Permissions tab.
    2. Select all or select the necessary permissions for your integration based on the actions it will perform (for example, read:tickets, edit:tickets, read:customers, edit:customers, admin:webhooks).
      V1xSP_HaloPSA_5=1198cd84-de58-461f-8113-b3fb6e6d0082.png
  4. Click Save.