---
title: AX Semantics
slug: WeGg-ax-semantics
docTags: 
createdAt: 2026-02-23T13:07:29.336Z
---

With the AX Semantics app in Make, you can manage the documents in your AX Semantics account.

# Requirements

To use the AX Semantics app in Make, you must have an [AX Semantics account](https://en.ax-semantics.com/).

# Connect AX Semantics and Make

To get started, you must first create a connection between AX Semantics and Make, allowing the two services to communicate.

To create the connection, you need to:

::::WorkflowBlock
:::WorkflowBlockItem
[Obtain a Refresh token in your AX Semantics account.](docId:5x_sKWtfdqR7_cYFA78F7)&#x20;
:::

:::WorkflowBlockItem
[Create the connection in Make.](docId:5x_sKWtfdqR7_cYFA78F7)
:::
::::

## Obtain your Refresh Token in AX Semantics

Before you create the connection in Make, you should first obtain a Refresh token in your AX Semantics account.

To obtain the Refresh token:

::::WorkflowBlock
:::WorkflowBlockItem
Log in to your AX Semantics account.
:::

:::WorkflowBlockItem
Click **API Access**.
:::

:::WorkflowBlockItem
Copy the **Refresh Token** value and store it in a safe place.
:::
::::

You'll use this value in the **Refresh Token** connection field in Make.

## Create the connection in Make

Once you have your AX Semantics Refresh Token, you're ready to create the connection in Make.

To create the connection:

::::WorkflowBlock
:::WorkflowBlockItem
Log in to your Make account, add an AX Semantics module to your scenario, and click **Create a connection**.
:::

:::WorkflowBlockItem
Optional: In the ​​**Connection name​​** field, enter a name for the connection.
:::

:::WorkflowBlockItem
In the ​​**Refresh Token** field, enter the **Refresh Token** you copied from your AX Semantics account.&#x20;
:::

:::WorkflowBlockItem
Click **Save**.
:::

:::WorkflowBlockItem
If prompted, authenticate your account and confirm access.
:::
::::

You've successfully created the connection and can now use the AX Semantics app in your scenarios. If you want to make changes to your connection in the future, follow the steps [here](docId\:SO88FM6pkT0G-adKDDfzZ).

# Set up an AX Semantics webhook

The AX Semantics app has `instant` modules—webhooks that watch for certain changes in AX Semantics and immediately start your scenario when those changes happen. To use these modules, you must set up the webhook in your AX Semantics account.

To set up the webhook:

::::WorkflowBlock
:::WorkflowBlockItem
Add an AX Semantics `instant`​ module to your scenario and click **Create a webhook​**​.
:::

:::WorkflowBlockItem
Optional: Enter a name for the webhook in the ​**Webhook name​​** field.
:::

:::WorkflowBlockItem
Click ​**Save**​ > ​**Copy address to clipboard**​​. You'll paste this address in your \{app name} account.
:::

:::WorkflowBlockItem
Log in to your AX Semantics account.
:::

:::WorkflowBlockItem
Click the Project in which you want to add the webhook.
:::

:::WorkflowBlockItem
Click the **Settings** button.
:::

:::WorkflowBlockItem
Click ***Instant Generation Endpoints***.
:::

:::WorkflowBlockItem
Click **Create a New Instant Generation Endpoint** and enter the URL address copied in step 3.
:::
::::

Your webhook is now set up. When the selected change occurs in AX Semantics, Make will immediately be notified and start your scenario.

## Triggers

:::ExpandableHeading
### Watch Generated Content

Triggers when new content is generated.

| **Webhook Name** | Enter a name for the webhook.                                                       |
| ---------------- | ----------------------------------------------------------------------------------- |
| **Connection**   | [Establish a connection to your AX Semantics account](docId:5x_sKWtfdqR7_cYFA78F7). |
:::

## Actions

:::ExpandableHeading
### Add a Document

Uploads your data.

| **Connection**    | [Establish a connection to your AX Semantics account](docId:5x_sKWtfdqR7_cYFA78F7).                                                                                                     |
| ----------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Collection ID** | Select or map the Collection ID of the document.                                                                                                                                        |
| **Document Data** | Enter (map) the document data in the JSON format to publish the content in your collection. You can provide either a name and/or UID parameters that help to find your document easily. |
:::

:::ExpandableHeading
### Update a Document

Updates an existing document.

| **Connection**    | [Establish a connection to your AX Semantics account](docId:5x_sKWtfdqR7_cYFA78F7).                                                                                                     |
| ----------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Collection ID** | Select or map the collection ID of the document which you want to update.                                                                                                               |
| **Document ID**   | Select or map the Document ID whose details you want to update.                                                                                                                         |
| **Document Data** | Enter (map) the document data in the JSON format to publish the content in your collection. You can provide either a name and/or UID parameters that help to find your document easily. |
:::

:::ExpandableHeading
### Get Details of a Document

Shows details of a document.

| **Connection**    | [Establish a connection to your AX Semantics account](docId:5x_sKWtfdqR7_cYFA78F7). |
| ----------------- | ----------------------------------------------------------------------------------- |
| **Collection ID** | Select or map the Collection ID whose document details you want to retrieve.        |
| **Document ID**   | Select or map the Document ID whose details you want to retrieve.                   |

###
:::

:::ExpandableHeading
### Delete a Document

Deletes a document.

| **Connection**    | [Establish a connection to your AX Semantics account](docId:5x_sKWtfdqR7_cYFA78F7). |
| ----------------- | ----------------------------------------------------------------------------------- |
| **Collection ID** | Select or map the Collection ID whose document you want to delete.                  |
| **Document ID**   | Select or map the Document ID you want to delete.                                   |
:::

:::ExpandableHeading
### Make an API Call

Performs an arbitrary authorized API call.

| **Connection**   | [Establish a connection to your AX Semantics account](docId:5x_sKWtfdqR7_cYFA78F7).                                                                                                                                                                                                           |
| ---------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **URL**          | Enter a path relative to `https://api.ax-semantics.com` For example: `/v3/documents/`<br />For the list of available endpoints, refer to the [AX Semantics API Documentation](https://developers.ax-semantics.com/).                                                                          |
| **Method**       | Select the HTTP method you want to use:<br />**GET**<br />to retrieve information for an entry.<br />**POST**<br />to create a new entry.<br />**PUT**<br />to update/replace an existing entry.<br />**PATCH**<br />to make a partial entry update.<br />**DELETE**<br />to delete an entry. |
| **Headers**      | Enter the desired request headers. You don't have to add authorization headers; we already did that for you.                                                                                                                                                                                  |
| **Query String** | Enter the request query string.                                                                                                                                                                                                                                                               |
| **Body**         | Enter the body content for your API call.                                                                                                                                                                                                                                                     |


:::

:::ExpandableHeading
### Example of Use - List Collections

The following API call returns all the collections from your AX Semantics account:

**URL**:

`/v3/collections/`

**Method**:

`GET`



::Image[]{src="https://api.archbee.com/api/optimize/oAyFj2GHlBeBVWF5OAir2/UgtgiBnQ1NTJGhQGgmmV1_uuid-6915a0e9-ca28-93a1-bc61-edceb70146a1.png" size="48" width="489" height="1028" position="center" showCaption="false"}
:::

## Searches

:::ExpandableHeading
### Search Documents

Search documents by given criteria.

| **Connection**       | [Establish a connection to your AX Semantics account](docId:5x_sKWtfdqR7_cYFA78F7).                      |
| -------------------- | -------------------------------------------------------------------------------------------------------- |
| **Collection ID**    | Select or map the Collection ID whose documents you want to search.                                      |
| **Processing State** | Select or map the document processing status:<br />* *Generated*
* *Requested*
* *Delivered*
* *None*    |
| **Ordering**         | Select or map the order to arrange the documents:<br />* *Newest changes first*
* *Oldest changes first* |
| **Modified Before**  | Enter (map) the date to search the documents that were modified on or before the specified date.         |
| **Modified Since**   | Enter (map) the date to search the documents that were modified on or after the specified date.          |
| **Limit**            | Set the maximum number of results Make should return during one execution cycle.                         |


:::

:::ExpandableHeading
### Setting Up AX Semantics Webhooks

1. Open the *Watch Generated Content* module, enter a name for the webhook, click *Save*, and copy the URL address to your clipboard. Click *OK* and save the trigger.

::Image[]{src="https://api.archbee.com/api/optimize/oAyFj2GHlBeBVWF5OAir2/5pyHjWy0NNRCaL52eWArD_uuid-74752b4f-3f63-f38b-3fe4-45faf1b1af9a.gif" size="100" width="1498" height="767" position="center" showCaption="false" indent="2"}

2. Log in to your AX Semantics account.
3. Click the Project in which you want to add the webhook.

::Image[]{src="https://api.archbee.com/api/optimize/oAyFj2GHlBeBVWF5OAir2/Kpp5U9M5LGdvPo2itPS9r_uuid-5500316c-f02c-03db-0619-6f621fd0cd20.png" size="100" width="978" height="420" position="center" caption="61f2669acc99e.png" showCaption="true" indent="2"}

4. Click the Settings button.

::Image[]{src="https://api.archbee.com/api/optimize/oAyFj2GHlBeBVWF5OAir2/F3q5wZiviwtCV84yy0O9Q_uuid-b6874cdd-8401-2fcf-e4ee-9ef6e89a7730.png" size="100" width="1919" height="932" position="center" showCaption="false" indent="2"}

5. Click *Instant Generation Endpoints*.

::Image[]{src="https://api.archbee.com/api/optimize/oAyFj2GHlBeBVWF5OAir2/8qCQ4OATpFqpbx1nfLYjw_uuid-dd5e9cc4-fb0c-4970-4819-a92cff5b24c9.png" size="100" width="1918" height="940" position="center" showCaption="false" indent="2"}

6. Click *Create a New Instant Generation Endpoint* and enter the URL address copied in step 1.


:::

