You can use the AdminPulse API and webhooks to connect AdminPulse to other software. This allows another application to retrieve data from AdminPulse, add data or perform actions.
You can build a standard integration that multiple AdminPulse offices can use or a custom integration for one office.
This article explains the difference between these options, where to find the technical documentation and how to create an API key.
Which type of integration do you want to build?
A standard integration as a software provider
Are you a software provider looking to offer an integration that multiple AdminPulse offices can use? First consult the AdminPulse developer documentation and submit a request to our support team.
Briefly describe the integration you want to offer and the specific use cases it supports. We will then contact you to schedule an intake call to discuss the possibilities and next steps.
A custom integration for one office
Do you want to connect AdminPulse to other software for use within one office? First check the list of connected apps in AdminPulse to see whether a standard integration already exists.
Is there no suitable standard integration? You have two options:
- A custom integration using the API and webhooks: your office or IT partner builds an integration tailored to your needs.
- Zapier: connect AdminPulse to many other applications and set up automated workflows without writing code.
What are an API and a webhook?
What is an API?
An API (Application Programming Interface) allows two applications to communicate with each other. Through the AdminPulse API, another application can, for example, retrieve relation data, add relations or registrations and update task statuses.
What is a webhook?
With a webhook, AdminPulse automatically notifies another application when something changes. This means that the application does not need to repeatedly ask AdminPulse whether new or updated data is available.
A webhook can, for example, send an event when a document, email, invoice, registration, relation, task, task schedule, to-do or user is created, updated or deleted.
You configure webhooks through the API, not through a screen in AdminPulse.
Where can you find the technical documentation?
You can use the AdminPulse developer documentation for both standard integrations and custom office integrations. It provides information about authenticating with the API, the available API features, configuring webhooks, the structure of webhook messages and how to verify that a message came from AdminPulse.
How do you create an API key in AdminPulse?
An API key gives another application access to AdminPulse within the permissions that the office assigns to the key.
👉 Treat an API key like a password. Only share it securely with the software provider or IT partner that manages the integration.
- Go to My profile > API keys. You can also open the page directly via API keys in AdminPulse.
- Create a new API key and enter a clear Name. This will help you identify what the key is used for later.
- Select an Expiration date that matches the expected duration of the integration.
-
Under Client, select the software package for which you are creating the API key.
Is the software package not listed and are you building your own integration? Select Own office integration.
- Assign only the permissions that the integration needs. Agree with your IT partner or software provider which permissions are required.