AI
AX Semantics
11 min
with the ax semantics app in {{product name}} , you can manage the documents in your ax semantics account requirements to use the ax semantics app in {{product name}} , you must have an ax semantics account connect ax semantics and {{product name}} to get started, you must first create a connection between ax semantics and {{product name}} , allowing the two services to communicate to create the connection, you need to ax semantics /#obtain your refresh token in ax semantics ax semantics /#create the connection in obtain your refresh token in ax semantics before you create the connection in {{product name}} , you should first obtain a refresh token in your ax semantics account to obtain the refresh token log in to your ax semantics account click api access copy the refresh token value and store it in a safe place you'll use this value in the refresh token connection field in {{product name}} create the connection in {{product name}} once you have your ax semantics refresh token, you're ready to create the connection in {{product name}} to create the connection log in to your {{product name}} account, add an ax semantics module to your {{scenario singular lowercase}} , and click create a connection optional in the connection name field, enter a name for the connection in the refresh token field, enter the refresh token you copied from your ax semantics account click save if prompted, authenticate your account and confirm access you've successfully created the connection and can now use the ax semantics app in your {{scenario plural lowercase}} if you want to make changes to your connection in the future, follow the steps connect an application docid\ so88fm6pkt0g adkddfzz set up an ax semantics webhook t he ax semantics app has instant modules — webhooks that watch for certain changes in ax semantics and immediately start your {{scenario singular lowercase}} when those changes happen to use these modules, you must set up the webhook in your ax semantics account to set up the webhook add an ax semantics instant module to your {{scenario singular lowercase}} and click create a webhook optional enter a name for the webhook in the webhook name field click save > copy address to clipboard you'll paste this address in your {app name} account log in to your ax semantics account click the project in which you want to add the webhook click the settings button click instant generation endpoints 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, {{product name}} will immediately be notified and start your {{scenario singular lowercase}} triggers watch generated content triggers when new content is generated webhook name enter a name for the webhook connection ax semantics docid 5x skwtfdqr7 cyfa78f7 actions add a document uploads your data connection ax semantics 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 update a document updates an existing document connection ax semantics /#connect ax semantics and 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 get details of a document shows details of a document connection ax semantics /#connect ax semantics and 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 delete a document deletes a document connection ax semantics /#connect ax semantics and 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 make an api call performs an arbitrary authorized api call connection ax semantics /#connect ax semantics and 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 example of use list collections the following api call returns all the collections from your ax semantics account url /v3/collections/ method get searches search documents search documents by given criteria connection ax semantics /#connect ax semantics and 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 {{product name}} should return during one execution cycle setting up ax semantics webhooks 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 log in to your ax semantics account click the project in which you want to add the webhook click the settings button click instant generation endpoints click create a new instant generation endpoint and enter the url address copied in step 1