---
openapi: 3.0.0
info:
  title: Nimbo webhooks
  version: 1.0.0
  description: Nimbo API reference. Use the API host and integration access provided
    by Nimbo.
servers:
- url: https://api.example.test
  description: Reference only; confirm your integration host with Nimbo
paths:
  "/oauth/token":
    post:
      summary: POST /oauth/token
      responses:
        '200':
          content:
            application/json:
              schema:
                type: object
                properties:
                  access_token:
                    type: string
                  token_type:
                    type: string
                  expires_in:
                    type: integer
                  refresh_token:
                    type: string
                  created_at:
                    type: integer
          description: Successful response
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                username:
                  type: string
                password:
                  type: string
                grant_type:
                  type: string
      operationId: legacy_nimbo_webhooks_post__oauth_token
      parameters: []
  "/webhooks":
    post:
      summary: POST /webhooks
      responses:
        '200':
          description: Successful response
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                url:
                  type: string
                topic:
                  type: string
                event_name:
                  type: string
                authentication_data:
                  type: object
                  properties:
                    secret:
                      type: string
                nimbo_access_token:
                  type: string
      operationId: legacy_nimbo_webhooks_post__webhooks
      parameters: []
    get:
      summary: GET /webhooks
      responses:
        '200':
          content:
            application/json:
              schema:
                type: object
                properties:
                  webhooks:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: integer
                        organization_id:
                          type: integer
                        url:
                          type: string
                          format: uri
                        event_topic:
                          type: string
                        event_name:
                          type: string
                        authentication_data:
                          type: object
                          properties:
                            secret:
                              type: string
                        status:
                          type: string
                        created_at:
                          type: string
                          format: date-time
                        deleted_at:
                          nullable: true
          description: Successful response
      security:
      - BearerAuth: []
      operationId: legacy_nimbo_webhooks_get__webhooks
      parameters: []
  "/events":
    get:
      summary: GET /events
      responses:
        '200':
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  properties:
                    id:
                      type: integer
                    topic:
                      type: string
                    name:
                      type: string
                    source:
                      type: string
                    behaviour:
                      type: string
                    compensating_event:
                      type: object
                    previous_event:
                      type: string
                    root_event:
                      type: string
                    event_schema_version:
                      type: string
                    value:
                      type: object
                      properties:
                        id:
                          type: integer
                        first_name:
                          type: string
                        last_name:
                          type: string
                        telephone:
                          nullable: true
                        email:
                          type: string
                          format: email
                        created_at:
                          type: string
                          format: date-time
                        updated_at:
                          type: string
                          format: date-time
                        born_at:
                          type: string
                          format: date
                        gender:
                          type: string
                        avatar_file_name:
                          nullable: true
                        avatar_content_type:
                          nullable: true
                        avatar_file_size:
                          nullable: true
                        avatar_updated_at:
                          nullable: true
                        telephone2:
                          type: string
                        person_attributes:
                          type: object
                          properties:
                            send_reminders:
                              type: boolean
                        account_id:
                          type: integer
                        address_state_id:
                          type: integer
                        organization_id:
                          type: integer
                        notes:
                          nullable: true
                        deleted_at:
                          nullable: true
                        phone_country_id:
                          type: integer
                        creator_id:
                          type: integer
                        updater_id:
                          type: integer
                        is_migrated:
                          type: boolean
                        without_cellphone:
                          type: boolean
                        nimbochat_invitation_date:
                          nullable: true
                        admission_form:
                          type: boolean
                        cirrus_patient_id:
                          nullable: true
                        person_token_id:
                          nullable: true
                        medical_record:
                          type: string
                        send_welcome_email:
                          type: boolean
                    key:
                      type: string
                    domain:
                      type: string
                      format: style
                    organization_id:
                      type: integer
                    tries_left:
                      type: integer
                    created_at:
                      type: string
                      format: date-time
                    logs:
                      type: array
                      items:
                        type: object
                        properties:
                          id:
                            type: integer
                          target_url:
                            type: string
                            format: uri
                          authentication_data:
                            type: object
                            properties:
                              secret:
                                type: string
                          request:
                            type: string
                            format: style
                          response:
                            type: string
                            format: style
                          event_id:
                            type: string
                          response_code:
                            nullable: true
                          retries_left:
                            type: integer
                          created_at:
                            type: string
                            format: date-time
          description: Successful response
      security:
      - BearerAuth: []
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                offset:
                  type: integer
                limit:
                  type: integer
                topic:
                  type: string
                name:
                  type: string
      operationId: legacy_nimbo_webhooks_get__events
      parameters: []
  "/webhooks/{webhook_id}":
    delete:
      summary: DELETE /webhooks/{webhook_id}
      responses:
        '200':
          content:
            application/json:
              schema:
                type: object
                properties:
                  deleted:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: integer
          description: Successful response
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                nimbo_access_token:
                  type: string
      operationId: legacy_nimbo_webhooks_delete__webhooks_webhook_id
      parameters:
      - name: webhook_id
        in: path
        required: true
        schema:
          type: string
components:
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer