Webhook

Organization webhook event

​

Mindoo sends this request to the webhook URL configured for your organization in Settings. The JSON body includes your organization id and a discriminated payload whose type indicates the event (for example encounter.status when an encounter’s status changes). Respond with any 2xx status to acknowledge receipt.

Body
required
application/json

JSON body POSTed to your organization webhook URL configured in Settings.

  • organizationId
    Type: string Pattern: ^[0-9a-z]+$Format: cuid2
    required

    The organization this webhook event belongs to.

  • payload
    required

    Emitted when an encounter’s status changes (for example to ONGOING, FINALIZING, FINISHED, or ABANDONED).

    • encounterId
      Type: string Pattern: ^[0-9a-z]+$Format: cuid2
      required

      The encounter whose status changed.

    • status
      Type: string · Encounter statusenum
      required

      %future added value is a placeholder that is inserted to ensure you handle the possibility that new enum variants may be added by the server after your application has been deployed. This value should not be handled explicitly.

      values
      • ABANDONED
      • FINALIZING
      • FINISHED
      • ONGOING
      • %future added value
    • type
      enum
      const:  
      encounter.status
      required
      values
      • encounter.status
Responses
  • 200

    Webhook acknowledged

Request Example for postorganization-webhook
{
  "organizationId": "",
  "payload": {
    "encounterId": "",
    "status": "ABANDONED",
    "type": "encounter.status"
  }
}
No Body

Webhook acknowledged