Events

Description

For each webhook event, you can review when the event occurs, descriptions about the payload object parameters and an example of the payload.

Index

These are the currently available events to be notified via webhook:

• consultation_closed
• message_sent.
• user_banned.
• medical_report_created.
• medical_prescription_modified.

Format

The webhooks are a POST HTTP request, sent as a JSON document.

Headers

The requests will contain some extra headers:

Header	Value	Description
Content-type	application/json
Accept	application/json
apiKey	COMPANY_API_KEY	The company's Api Key
secretKey	COMPANY_SECRET_KEY	The company's Secret Key

Common payload properties

These fields are part of every event notified as webhook:

Key	Type	Description
type	string	The name of the event.
occurred_on	datetime	The moment the event happened, using ISO8601 extended format (Y-m-d\TH:i:sO).
payload	object	The event body.

Events

consultation_closed

A consultation has been closed.

This event is fired in the following scenarios:

• A Professional has manually marked a conversation as resolved in the Workplace.

Medical data sharing

Some medical data fields are only included in the payload if the company is explicitly configured to allow medical data sharing. If medical data sharing is disabled, these fields will be omitted from the payload.

Payload object

Field	Type	Description
room_closing_log.room_closing_log_id	integer	Identifier of the closing log entry.
room_closing_log.speciality_consultation_type_id	integer	Identifier of the speciality consultation type.
room_closing_log.speciality_consultation_type_name	string	Name of the speciality consultation type.
room_closing_log.room_id	integer	Identifier of the consultation room.
room_closing_log.status	string	Final status of the consultation. Possible values: resolved, on_hold (user has been attended to, but has been put on hold pending further information from the professional), archived (resolved, but the case's outcome does not correspond to a medical diagnosis).
room_closing_log.reason	string	Resolution reason chosen by the professional. (only when medical data sharing is enabled)
room_closing_log.additional_classification	string	Additional classification provided (if any). (only when medical data sharing is enabled)
room_closing_log.diagnosis_icd11_code	string	ICD-11 code of the diagnosis. (only when medical data sharing is enabled)
room_closing_log.diagnosis_icd11_text	string	Textual description of the ICD-11 diagnosis. (only when medical data sharing is enabled)
customer.token	string	The customer identifier.
customer.hash	string	The customer hash.
customer_usage.services_limit	integer	Maximum number of services available in the current period.
customer_usage.services_used	integer	Number of services already used in the current period.
customer_usage.period.start_date	string	Start date of the usage period.
customer_usage.period.end_date	string	End date of the usage period.
customer_usage.remaining_services	integer	Remaining services available in the current period.
company.api_key	string	The company api key.

Payload example

{
  "room_closing_log": {
    "room_closing_log_id": 34123,
    "speciality_consultation_type_id": 52,
    "speciality_consultation_type_name": "Dermatologia",
    "room_id": 23,
    "status": "resolved",
    "reason": "Solicitud pruebas diagnósticas",
    "additional_classification": "Pruebas de alergias",
    "diagnosis_icd11_code": "CA00",
    "diagnosis_icd11_text": "Nasofaringitis aguda"
  },
  "customer": {
    "token": "00000000A",
    "hash": "13d960ac-3f15-499a-b16e-67641fd793a3"
  },
  "customer_usage": {
    "services_limit": 40,
    "services_used": 1,
    "period": {
      "start_date": "2025-09-01",
      "end_date": "2025-09-30"
    },
    "remaining_services": 39
  },
  "company": {
    "api_key": "09hr2hpo0va"
  }
}

message_sent

The message has been sent.

Payload object

Field	Type	Description
type	string	The owner of the message
customer.token	string	The customer identifier.
professional.token	string	The professional identifier.
professional.speciality	string	The name of the speciality.
message.room_id	int	The unique id of the chat.
message.message_id	uuid	The unique id of the message.

Payload example

{
    "type": "professional",
    "message":{
        "message_id": "440fb66f-030a-4b48-9c18-1223e5c50",
        "type": "string",
        "text": "content of this message",
        "room_id": 102548
    },
    "customer": {
        "token": "00000000A"
    },
    "professional": {
        "token": "564692f7-0596-435c-b1a7-7bf2af16873a",
        "speciality": "Medicina General"
    }
}

user_banned

The user has been banned.

Payload object

Field	Type	Description
token	string	The customer identifier.
reason	string	Reason for the user being banned.

Payload example

{
    "customer": {
        "token": "00000000A"
    },
    "reason": "Mal uso del servicio."
}

medical_report_created

A medical report has been created.

Payload object

Field	Type	Description
report.url	string	The medical report PDF url.
customer.token	string	The customer identifier.
professional.token	string	The professional identifier.
professional.speciality	string	The name of the speciality.

Payload example

{
   "report": {
       "url": "https://drive.meetingdoctors.com/medical_report.pdf"
   },
   "customer": {
        "token": "00000000A"
    },
    "professional": {
        "token": "5526b65f-9cda-4981-abf9-f7391aa76446",
        "speciality": "Medicina General"
    }
}

medical_prescription_modified

The app has been opened.

Payload object

Field	Type	Description
customer.token	string	The customer identifier.
electronic_prescription.tin	uuid	The unique id of the prescription.
electronic_prescription.pdf	string	The prescription PDF url.
electronic_prescription.last_modified_at	string	The last prescription date emitted.
electronic_prescription.treatments	array	The contents of the prescription.

Payload example

{
    "customer": {
        "token": "00000000A"
    },
    "electronic_prescription": {
        "tin": "09120193201",
        "url": "https://drive.meetingdoctors.com/electronic_prescription.pdf"
        "last_modified_at": "Y-m-d\TH:i:sO",
        "treatments": []
    }
}