Tip: You can use filters for better results
About Incoming Mappings
Inside the Admin panel go to Settings → Incoming Mappings to open the table view of incoming mappings. From there on you have multiple variants of establishing interaction with another system. You can either do it with the help of the setup wizard inside the page itself, which guides you through step-by-step or manage systems, interface permissions, and API Keys manually one after another. When you edit them you can use each page on your own.
What are Incoming Mappings?
Incoming mappings allow external systems to send data into Fieldcode – for example, to create or update tickets automatically. This helps reduce manual work and ensures systems stay in sync.
When to use Incoming Mappings?
- You want to receive ticket data from a partner system
- You want to automate ticket creation or updates from external tools
- You need to integrate Fieldcode with a third-party platform
- Save absence ->
- ….
- A partner system sends a POST request to your /ticket-create endpoint with ticket data. The mapping logic extracts the ticket ID, customer name, and ticket description, and creates a new ticket in Fieldcode.
1. Create Endpoint
An endpoint is where the data for a specific action should be sent from the external system.
- The Active toggle is enabled by default. Decide if your endpoint should be activated after the configuration is completed or not.
- Enter a name for your new endpoint.
ADD DESCRIPTION - (Optional) - Enter a description for your endpoint to make it better identifiable
- You can pick a system from the list if you have already registered an external system.
- (Optional) - If you haven't registered any system yet, you can click the register system button. This will open a window from the right side where you can register a new system, similar as on the Systems page.
- Enter a valid path. You can for example use your endpoint name.
ADD DESCRIPTION
CHECK COPILOT)
- Select the method you want to use for the data exchange. The methods are explained in more detail in the table below.
| Method | Explanation |
|---|---|
| Get (Read) | The client retrieves a resource from the server. The client should not send data, only retrieve. |
| Post (Add) | The client sends data to the server, so that the server can create a new resource out of it. |
| Put (Create/Replace) | The client specifies a location, and sends some data. If no resource exists on that location, a new one will be created using the data the client sent, if it already exists. It will be replaced by the new data. |
| Patch (Update) | The client sends instructions to the server how to change an existing resource. |
| Delete (Remove) | The client requests the deletion of a resource from the server. |
- Select if you want to add a body to the HTTP request. For example, you could select yes if you use a .json file.
ADD DESCRIPTION
- Click on the Next button to proceed to the Permissions step.
2. Select Interface Permission(s)
Select interface permissions that will make the Fieldcode endpoint accessible for the external system. Choose from existing permissions or create new ones.
- Select one of the three authentication methods for your incoming mapping.
API Key:
Basic Auth:
OAuth2:
- Select interface permissions that should be used for the incoming mapping.
Important: Make sure to choose interface permissions that match you authentication method. If you do not have matching permissions you can create them on the interface permissions page. Then you can go and create an interface user and assign this permission to it. If you chose the authentication method API key, you can go and create a new API key and assign this permission to it.
- You can pick a permission from the list if you have already created interface permissions.It would be good if you enter a name that describes the purpose of the interface permission - for example, for the ones you want to particularly allow or restrict.
3. Secure with API key
The permission of the Fieldcode endpoint can be granted to the external system with an API key. When using an existing API key, please ensure that the set of permissions included in this API key can be granted to the external system. Otherwise, generate a new API key with a set of permissions suitable for this specific external system.
- Click on "Generate secure API key" if you don't have an existing API key or you don't want to use an existing one.
- The Create Security Configuration page will open.
- The Active toggle for the "Security configuration status" is enabled by default. You could for example disable it if you want to not share the key yet.
- Enter a name for your API key.
- You can now add related permissions with your API key. In this example we selected the default permissions. But you could also configure Interface Permissions by yourself.
- (Optional) - You can configure an expiration date for your API key. After the expiration date the API key will be no longer valid.
- Click on Save to finish the basic setup of your Incoming Mapping.
4. Adding mapping
You will be asked to add a mapping right after finishing the basic setup.
- You will be asked to add a mapping right after finishing the basic setup. You can either skip the incoming mapping for now, or start to add your actual incoming mapping!
- Select "Yes, Add Mapping".
- The first step is to pick an action from the dropdown.
Action Types Explained:
- Save Absence:
- Create Ticket:
- Create and update items:
- Update Absence:
- Create Ticket Info:
- Save Document:
- Submit Interface Form:
- Let's assume you want to use the "Create Ticket" action.
- You pick it and select Continue.
