Webhook

Organization webhook event

​

Mindoo sends this request to the webhook URL configured in your organization 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 a new encounter is created.

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

      The agent associated with the encounter, or null when the encounter has no agent (for example a scribe encounter).

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

      The consult invitation that led to the encounter, or null when the encounter was not created from an invitation.

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

      The encounter this event applies to.

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

      The team the encounter belongs to.

    • type
      const:  
      encounter.created
      required
Responses
  • 200

    Webhook acknowledged

Request Example for postorganization-webhook
{
  "organizationId": "",
  "payload": {
    "agentId": "",
    "consultInvitationId": "",
    "encounterId": "",
    "teamId": "",
    "type": "encounter.created"
  }
}
No Body

Webhook acknowledged