Using External ID for third-party services

Owned by Jan Mucha (Unlicensed)
Last updated: Jan 19, 2023 by Jan Zimmermann
2 min read

What it's good for?
The external ID is used to uniquely identify the tree element for integration into third-party services. An external ID can be created in user interface in section API. The External ID can be used in GraphQL queries/mutations in Survilla cloud API.

Adding an External ID

  1. In the top right corner, press the button Avatar with the username you are logged in with.

  2. Open the  API tab.

  3. Select the  External ID application interface.

Open section External ID

4. Press the “+ Add identifier” button.

Add new External ID

5. Click in the Item text box to open the directory structure window and select the folder or element to which you want to assign an external ID.

6. Fill in the External Identifier and press “Save”.
External ID is created. Then you will see in a list of created External IDs.

 

Adding new External ID

 

Editing an External ID

  1. Press the button “Edit” next to the corresponding external ID.

  2. Edit the necessary parameters.

  3. Confirm with the “Save” button

Editing External ID

Deleting an External ID

  1. Press the button “Delete” next to the external ID you want to delete.

Deleting External ID

Example

 

 

Examples of integrations

  • Integration with Winshop - you can record billing action, etc