---
title: AX Semantics modules
slug: ax-semantics-modules
image: https://make-cxp-documentation.ams3.cdn.digitaloceanspaces.com/apps-center-icons/PREVIEW_DEFAULT.png
createdAt: 2025-03-10T17:24:10.885Z
---
After connecting to the AX Semantics app, you can use the following modules to build your scenarios.
# Triggers
:::ExpandableHeading
## Watch Generated Content
Triggers when new content is generated.
| **Field** | **Description** |
| ---------------- | ----------------------------------------------------------------------------------- |
| **Webhook Name** | Enter a name for the webhook. |
| **Connection** | [Establish a connection to your AX Semantics account](docId:5x_sKWtfdqR7_cYFA78F7). |
See the [Setting Up AX Semantics Webhooks](docId:5x_sKWtfdqR7_cYFA78F7) to add webhooks in your AX Semantics account.
:::
# Actions
:::ExpandableHeading
## Add a Document
Uploads your data.
| **Field** | **Description** |
| ----------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **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.
| **Field** | **Description** |
| ----------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **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.
| **Field** | Description |
| ----------------- | ----------------------------------------------------------------------------------- |
| **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.
| **Field** | Description |
| ----------------- | ----------------------------------------------------------------------------------- |
| **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.
| **Field** | **Description** |
| ---------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **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/`
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:
**GET**
to retrieve information for an entry.
**POST**
to create a new entry.
**PUT**
to update/replace an existing entry.
**PATCH**
to make a partial entry update.
**DELETE**
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/hiu3nVXSr1m0QUr2YFMH5_uuid-72f96119-2e68-8dea-7fbe-ce9a493f0689.png" size="48" width="494" height="1048" position="center" showCaption="false"}
Matches of the search can be found in the module's **Output** under *Bundle* > *Body > results.*
In our example, 104 collections were returned:
::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.
| **Field** | **Description** |
| -------------------- | -------------------------------------------------------------------------------------------------------------------- |
| **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:
- *Generated*
- *Requested*
- *Delivered*
- *None* |
| **Ordering** | Select or map the order to arrange the documents:
- *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. |
:::