All Collections
Configure Lime
Configure a Lime Integration
Configure a Lime Integration
Updated over a week ago

Combined with Lime's automated sending rules, integrations allows you to automate SMS and email sending using HL7 transactions. This makes it possible to communicate with your patients automatically based on different contexts: care pathways, facilities, clinics, status, and more.

1. Create a Lime API Key

  1. To create an API key, see the article Managing API Keys.

  2. Choose the scope Integration of Automated rules integration.

2. Call Lime API with the key

Build the following HTTPS request:

POST /api/v1/ext/adt HTTP/2
content-type: text/plain

cURL example:

curl --request POST \ 
--url '' \
--header 'content-type: text/plain' \
--header 'api-key: [REMPLACEZ PAR VOTRE CLÉ D’API]' \
--data '[HL7_MESSAGE]'

Javascript example:

method: 'POST',
body: HL7_MESSAGE,
headers: {
'Content-type': 'text/plain',
'api-key': API_KEY

3. Contact our team

In order to complete the integration, it is necessary for the Lime team to take care of some configuration steps. Contact us at for more details.

Did this answer your question?