Welcome to Maximizer Webhooks API!
The Maximizer Webhooks API (available for Maximizer Cloud only) is the easiest way to set up webhooks, allowing you to subscribe to and respond to changes in your Maximizer CRM.
For more information about webhooks, please see the Maximizer Webhooks guide.
For any questions or support, please reach out to us via Forums.
Steps to using the API
Step 1: Get Postman collection
To get familiar with Webhooks API, we recommend using Postman:
- Download Postman desktop client or use Web-version.
- You can fork or export our Webhooks Postman collection or download it from our GitHub.
- Open the collection in your Postman client.
- Export and adjust the Postman environment to make API requests.
Step 2: Get authenticated
To access Webhooks API, you will need to obtain an access token. The token owner must have an Administrator role. Regular users will not be able to manage webhooks.
There are two ways to accomplish this, but we recommend starting with the first one:
- Create a long-living Personal Access Token (more details about PAT) within your Maximizer account:
- Log in to your Maximizer account.
- Click on your profile photo to open the drop-down menu.
- Select "Personal Access Tokens" and follow the prompts to create a new PAT.
- Enter the name of the token, choose the expiration date and click "Save".
- Copy your token to a secure location.
- Authenticate by using
/authenticateendpoint (see Authentication section) - By using OAuth2
Step 3: Get familiar with our object relationships schema
Check out our Webhooks Postman collection to identify which objects are supported.
More detailed information about our domain schema and use cases can be found in our Octopus API documentation.
Step 4: Subscribe to the webhooks
Once you have identified the objects you are interested in, you can create Targets and Subscriptions by using Webhooks API.
HTTP Response Codes
200 OK - Webhooks API has completed your request (check the response body for more details).
401 Unauthorized - Webhooks API cannot authorize the request based on the provided credentials. Ensure that you have included a valid Bearer token in the request header.
408 Request Timeout - Webhooks API could not complete the request within the server's allotted timeout period. Please check your request, simplify it and try again. Please, see the Request Limits section below.
429 Too Many Requests - Webhooks API received an excessive number of requests from your client in a short period. To avoid exceeding the rate limit, please check the response header for the "Retry-After" time and wait until that time has elapsed before sending more requests.
5xx Internal Server Error - Webhooks API encountered an unexpected error while processing your request. Please try again later or contact support for assistance.