# Intely Documentation

> Intely's no-code interoperability platform and marketplace for healthcare provides the building blocks to make data and applications interoperable. The Intely API provides a way to programmatically access, integrate with, and build on Intely's Platform.

## Guides: Documentation
- [Welcome to Intely](https://documentation.intely.io/docs/getting-started.md)

## Guides: Implementation & Onboarding
- [Understanding Intely's Role](https://documentation.intely.io/docs/understanding-intelys-role.md)
- [How to Prepare for Your Integration](https://documentation.intely.io/docs/how-to-prepare-for-your-integration.md)
- [Engagement & Onboarding with Intely](https://documentation.intely.io/docs/engagement-onboarding-with-intely.md)
- [Scaling and Expanding Integrations with Intely](https://documentation.intely.io/docs/scaling-and-expanding-integrations-with-intely.md)
- [Timeline](https://documentation.intely.io/docs/timeline.md)
- [Post Onboarding Support](https://documentation.intely.io/docs/post-onboarding-support.md)

## Guides: Connectors
- [Apps](https://documentation.intely.io/docs/what-is-an-intely-app.md)
  - [App Interfaces](https://documentation.intely.io/docs/app-interfaces.md)
- [VPN Connections](https://documentation.intely.io/docs/vpn-connections.md)
- [Sandbox](https://documentation.intely.io/docs/sandbox.md)

## Guides: Basics & Building Blocks
- [Mappings](https://documentation.intely.io/docs/my-mappings.md)
- [Data Types](https://documentation.intely.io/docs/my-data-types.md)
- [Crosswalks](https://documentation.intely.io/docs/crosswalks.md)
- [Comparisons](https://documentation.intely.io/docs/comparisons.md)

## Guides: Workflow
- [Integration Builder](https://documentation.intely.io/docs/integration-builder.md)
  - [App Request](https://documentation.intely.io/docs/app-request.md)
  - [Authorization](https://documentation.intely.io/docs/authorization.md)
  - [Conditional](https://documentation.intely.io/docs/conditional.md)
  - [Comparison](https://documentation.intely.io/docs/comparison.md)
  - [Convert](https://documentation.intely.io/docs/convert.md)
  - [Crosswalk](https://documentation.intely.io/docs/crosswalk.md)
  - [Delay](https://documentation.intely.io/docs/delay.md)
  - [Execute Script](https://documentation.intely.io/docs/execute-script.md)
  - [Inc/Dec Counter](https://documentation.intely.io/docs/incdec-counter.md)
  - [Logging](https://documentation.intely.io/docs/logging.md)
  - [Loop](https://documentation.intely.io/docs/loop.md)
  - [Modify Variable](https://documentation.intely.io/docs/modify-variable.md)
  - [RESTful Request](https://documentation.intely.io/docs/restful-request.md)
  - [Run Integration](https://documentation.intely.io/docs/run-integration.md)
  - [Stop Workflow](https://documentation.intely.io/docs/stop-integration.md)
  - [Split HL7 Message](https://documentation.intely.io/docs/split-hl7-message.md)

## Guides: Organization Management
- [Users, Roles & Permissions](https://documentation.intely.io/docs/addingediting-users.md)
- [Notifications](https://documentation.intely.io/docs/notifications.md)

## Guides: Resources
- [Support](https://documentation.intely.io/docs/support.md)

## Guides: Interface Server
- [Interface Server](https://documentation.intely.io/docs/interface-server.md)
- [Interfaces](https://documentation.intely.io/docs/interface-server-interfaces.md)
- [Messages](https://documentation.intely.io/docs/interface-server-messages.md)
- [Logs](https://documentation.intely.io/docs/interface-server-logs.md)

## API Reference: Intely API
- Identity Management
  - [JWKS](https://documentation.intely.io/reference/get_jwks.md): Returns the Identity Server's public key set in the JWKS format.
  - [Get user token](https://documentation.intely.io/reference/post_noauth-user-login-token.md): Gets a user token from a personal access token. This endpoint uses basic auth. The username is the user's username and the password is the personal access token. The token that is issued is valid for…
  - [Validate user token](https://documentation.intely.io/reference/get_currentuser-validate.md): Takes a user token and makes sure it is valid. It returns the token if it is still valid.
  - [Get MCP server authorization token](https://documentation.intely.io/reference/post_noauth-user-login-mcptoken.md): Gets a authorization token from a personal access token for the Intely MCP server. This endpoint uses basic auth. The username is the user's username and the password is the personal access token.…
- Rosetta
  - [Get mappings](https://documentation.intely.io/reference/get_rosetta-mappings.md): Returns all of the mappings the user has access to. 10 results per page.
  - [Get mapping](https://documentation.intely.io/reference/get_rosetta-mapping-mappingid.md): Returns the details of a specific mapping.
  - [Execute mapping (asynchronous)](https://documentation.intely.io/reference/post_rosetta-mapping-mappingid-execute.md): Converts data based on the provided mapping asynchronously.
  - [Execute mapping (synchronous)](https://documentation.intely.io/reference/post_rosetta-mapping-mappingid-execute-sync.md): Converts data based on the provided mapping synchronously. The endpoint will timeout after 60 seconds. Call the asynchronous execute endpoint if the mapping takes longer than 60 seconds to run.
  - [Get comparisons](https://documentation.intely.io/reference/get_rosetta-comparisons.md): Returns all of the comparisons the user has access to. 10 results per page.
  - [Get comparison](https://documentation.intely.io/reference/get_rosetta-comparison-comparisonid.md): Returns the details of a specific comparison.
  - [Execute comparison (asynchronous)](https://documentation.intely.io/reference/post_rosetta-comparison-comparisonid-execute.md): Compares data based on the provided comparison asynchronously.
  - [Execute comparison (synchronously)](https://documentation.intely.io/reference/post_rosetta-comparison-comparisonid-execute-sync.md): Compares data based on the provided comparison synchronously. The endpoint will timeout after 60 seconds. Call the asynchronous execute endpoint if the comparison takes longer than 60 seconds to run.
- Connect
  - [Get integrations](https://documentation.intely.io/reference/get_integrations.md): Returns a list of integrations the user has access to.
  - [Get integration](https://documentation.intely.io/reference/get_integration-integrationid.md): Returns details of a specific integration.
  - [Execute integration (asynchronous)](https://documentation.intely.io/reference/post_integration-integrationid-execute.md): Executes an integration asynchronously.
  - [Execute integration (synchronous)](https://documentation.intely.io/reference/post_integration-integrationid-execute-sync.md): Executes an integration synchronously. The endpoint will timeout after 60 seconds. Call the asynchronous execute endpoint if the integration takes longer than 60 seconds to run.
  - [Execute Script (asynchronous)](https://documentation.intely.io/reference/post_script-scriptid-execute.md): Executes a script asynchronously.
  - [Execute Script (synchronous)](https://documentation.intely.io/reference/post_script-scriptid-execute-sync.md): Executes a script synchronously. The endpoint will timeout after 60 seconds. Call the asynchronous execute endpoint if the script takes longer than 60 seconds to run.
- Forms
  - [Validate API key](https://documentation.intely.io/reference/get_forms-api-key-validate.md): Validates an API key and returns the user details related to the key.
  - [Get workspaces](https://documentation.intely.io/reference/get_forms-api-workspace-all.md): Gets all of the workspaces for the user.
  - [Get forms](https://documentation.intely.io/reference/get_forms-api-form-all.md): Gets all of the forms for a user in the given workspace.
  - [Get form](https://documentation.intely.io/reference/get_forms-api-form-formid.md): Gets the details of an individual form.
  - [Get form fields](https://documentation.intely.io/reference/get_forms-api-form-fields-formid.md): Gets the fields of a specific form.
  - [Get form submissions](https://documentation.intely.io/reference/get_forms-api-form-submission-formid.md): Gets the submissions for an individual form.
  - [Get Zapier form submissions](https://documentation.intely.io/reference/get_forms-zapier-sample-submission.md): Gets a form submission in the Zapier format.
  - [Get Zapier form fields](https://documentation.intely.io/reference/get_forms-zapier-form-fields-formid.md): Gets the form fields in the Zapier format for an individual form.
  - [Add Zapier webhook](https://documentation.intely.io/reference/post_forms-zapier-add.md): Adds a Zapier webhook to a form.
  - [Enable Zapier webhook](https://documentation.intely.io/reference/post_forms-zapier-update-status.md): Enable or disable a Zapier webhook.
  - [Add Zapier form submission](https://documentation.intely.io/reference/post_forms-zapier-submission-add.md): Add a form submission using a Zapier action.
- Apps
  - [Get apps](https://documentation.intely.io/reference/get_apps.md): Returns a list of all the apps the user has access to.
  - [Get app](https://documentation.intely.io/reference/get_app-appid.md): Returns details of a specific app. The nested interface collections (instance fields, program fields, resources with their actions, and webhooks) are excluded by default and can be included with the…
  - [Get app instances](https://documentation.intely.io/reference/get_app-instances.md): Returns a list of all the app instances the user has access to.
  - [Get app instances for app](https://documentation.intely.io/reference/get_app-appid-instances.md): Returns a list of all the app instances the user has access to for the given app.
  - [Get app instance](https://documentation.intely.io/reference/get_app-appid-instance-instanceid.md): Returns details of a specific app instance.
  - [Create an instance for an app](https://documentation.intely.io/reference/post_app-appid-instance.md): Creates a new app instance with the given app and field data provided.
  - [Execute app request](https://documentation.intely.io/reference/post_app-appid-instance-instanceid-request-resourceid-actionid.md): Makes a request to an app resource.
  - [Update the entire app instance object](https://documentation.intely.io/reference/patch_app-appid-instance-instanceid.md): Updates the entire app instance with the supplied data. This is not a differential update.
  - [Delete app instance](https://documentation.intely.io/reference/delete_app-appid-instance-instanceid.md): Logically marks an app instance as deleted
  - [Restore an app instance](https://documentation.intely.io/reference/patch_app-appid-instance-instanceid-restore.md): Removes the logically deleted flag from an app instance
  - [Update the value of a field](https://documentation.intely.io/reference/patch_app-appid-instance-instanceid-field-fieldid.md): Update the value of a specific app instance field
  - [Get an app instances webhooks](https://documentation.intely.io/reference/get_app-appid-instance-instanceid-webhooks.md): Get a list of an app instances webhook definitions
  - [Create a webhook](https://documentation.intely.io/reference/post_app-appid-instance-instanceid-webhook.md): Creates a new webhook on the app instance
  - [Get an app instances webhook](https://documentation.intely.io/reference/get_app-appid-instance-instanceid-webhook-webhookid.md): Get a specific webhook definition from an app instance
  - [Update a webhook](https://documentation.intely.io/reference/patch_app-appid-instance-instanceid-webhook-webhookid.md): Update a specific webhook on an app instance
  - [Delete a webhook](https://documentation.intely.io/reference/delete_app-appid-instance-instanceid-webhook-webhookid.md): Permanently delete a webhook from an app instance
- Webhooks
  - [Execute webhook](https://documentation.intely.io/reference/post_webhook-webhookid-app-appid-instance-instanceid.md): Executes a webhook request for an app.
- Storage
  - [Get the contents of a directory.](https://documentation.intely.io/reference/get_storage-directory-files.md): Gets the contents of a directory in the file storage for an organization.
  - [Create a directory.](https://documentation.intely.io/reference/post_storage-directory.md): Creates a directory in the file storage for an organization.
  - [Delete a directory.](https://documentation.intely.io/reference/delete_storage-directory.md): Deletes a directory in the file storage for an organization.
  - [Upload a single file.](https://documentation.intely.io/reference/post_storage-file-upload-binary.md): Uploads a 100mb or smaller file to the file storage for an organization. If the file is larger than 100mb, use the multipart upload.
  - [Start a multipart file upload.](https://documentation.intely.io/reference/post_storage-file-upload-multipart-start.md): Starts a multipart file upload to the file storage for an organization.
  - [Upload a part of a multipart file upload.](https://documentation.intely.io/reference/post_storage-file-upload-multipart-uploadid-part.md): Uploads a part of a multipart file upload to the file storage for an organization.
  - [Complete a multipart file upload.](https://documentation.intely.io/reference/post_storage-file-upload-multipart-uploadid-complete.md): Completes a multipart file upload to the file storage for an organization. This endpoint should be called after all of the parts have been uploaded successfully.
  - [Upload a file from a URL.](https://documentation.intely.io/reference/post_storage-file-upload-url.md): Uploads a file from a URL to the file storage for an organization. The file will be downloaded and stored in file storage.
  - [Request to download a file.](https://documentation.intely.io/reference/post_storage-file-download.md): Requests to download a file from the file storage for an organization. A url to download the file will be returned in the response.
  - [Rename a file.](https://documentation.intely.io/reference/patch_storage-file-rename.md): Renames a file in the file storage for an organization.
  - [Move a file.](https://documentation.intely.io/reference/patch_storage-file-move.md): Moves a file in the file storage for an organization to a new directory.
  - [Copy a file.](https://documentation.intely.io/reference/post_storage-file-copy.md): Copies a file in the file storage for an organization to a new directory.
  - [Delete a file.](https://documentation.intely.io/reference/delete_storage-file-delete.md): Deletes a file in the file storage for an organization.
- Data Processor
  - [Get all jobs available for data processor.](https://documentation.intely.io/reference/get_data-processor-jobs.md): Returns a list of all jobs the user has access to.
  - [Get all jobs available for data processor.](https://documentation.intely.io/reference/get_data-processor-job-jobid.md): Returns a requested job
  - [Create a new execution for a data processor job.](https://documentation.intely.io/reference/post_data-processor-job-jobid-execute.md): Create a new execution for a data processor job.
  - [Create a new execution for a data processor job and run synchronously.](https://documentation.intely.io/reference/post_data-processor-job-jobid-execute-sync.md): Create a new execution for a data processor job and run synchronously.

## Changelog
- [Welcome to Intely](https://documentation.intely.io/changelog/welcome-to-intely.md)