SafetyCulture Webhooks API

openapi: 3.2.0
info:
  title: Mitti Webhooks API
  version: v1.349.8
  contact:
    name: Mitti Support
    url: https://help.mitti.com
    email: support@mitti.com
servers:
- url: https://api.mitti.com
security:
- BearerAuthentication: []
tags:
- name: Webhooks
paths:
  /webhooks/v1/token:
    get:
      summary: Get signature secret
      operationId: WebhooksService_GetToken
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/s12.webhooks.v1.GetTokenResponse'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/google.rpc.Status'
      tags:
      - Webhooks
    post:
      summary: Regenerate signature secret
      operationId: WebhooksService_GenerateToken
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/s12.webhooks.v1.GenerateTokenResponse'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/google.rpc.Status'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/s12.webhooks.v1.GenerateTokenRequest'
        description: The parameters for `GenerateToken`
        required: true
      tags:
      - Webhooks
  /webhooks/v1/webhooks:
    get:
      summary: List webhooks
      operationId: WebhooksService_ListWebhooks
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/s12.webhooks.v1.ListWebhooksResponse'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/google.rpc.Status'
      tags:
      - Webhooks
    post:
      summary: Create a webhook
      operationId: WebhooksService_CreateWebhook
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/s12.webhooks.v1.CreateWebhookResponse'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/google.rpc.Status'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/s12.webhooks.v1.CreateWebhookRequest'
        description: The parameters for `CreateWebhook`
        required: true
      tags:
      - Webhooks
  /webhooks/v1/webhooks/{webhook_id}:
    get:
      summary: Get a webhook
      operationId: WebhooksService_GetWebhook
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/s12.webhooks.v1.GetWebhookResponse'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/google.rpc.Status'
      parameters:
      - name: webhook_id
        description: The unique identifier for the webhook.
        in: path
        required: true
        schema:
          type: string
      tags:
      - Webhooks
    delete:
      summary: Delete a webhook
      operationId: WebhooksService_DeleteWebhook
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/s12.webhooks.v1.DeleteWebhookResponse'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/google.rpc.Status'
      parameters:
      - name: webhook_id
        description: The webhook unique identifier.
        in: path
        required: true
        schema:
          type: string
      tags:
      - Webhooks
    put:
      summary: Update a webhook
      operationId: WebhooksService_UpdateWebhook
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/s12.webhooks.v1.UpdateWebhookResponse'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/google.rpc.Status'
      parameters:
      - name: webhook_id
        description: The webhook unique identifier.
        in: path
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/s12.webhooks.v1.WebhooksService.UpdateWebhookBody'
        required: true
      tags:
      - Webhooks
components:
  schemas:
    s12.webhooks.v1.GenerateTokenRequest:
      type: object
      description: The parameters for `GenerateToken`
      title: GenerateTokenRequest
    google.protobuf.Any:
      type: object
      properties:
        '@type':
          type: string
          description: "A URL/resource name that uniquely identifies the type of the serialized\nprotocol buffer message. This string must contain at least\none \"/\" character. The last segment of the URL's path must represent\nthe fully qualified name of the type (as in\n`path/google.protobuf.Duration`). The name should be in a canonical form\n(e.g., leading \".\" is not accepted).\n\nIn practice, teams usually precompile into the binary all types that they\nexpect it to use in the context of Any. However, for URLs which use the\nscheme `http`, `https`, or no scheme, one can optionally set up a type\nserver that maps type URLs to message definitions as follows:\n\n* If no scheme is provided, `https` is assumed.\n* An HTTP GET on the URL must yield a [google.protobuf.Type][]\n  value in binary format, or produce an error.\n* Applications are allowed to cache lookup results based on the\n  URL, or have them precompiled into a binary to avoid any\n  lookup. Therefore, binary compatibility needs to be preserved\n  on changes to types. (Use versioned type names to manage\n  breaking changes.)\n\nNote: this functionality is not currently available in the official\nprotobuf release, and it is not used for type URLs beginning with\ntype.googleapis.com.\n\nSchemes other than `http`, `https` (or the empty scheme) might be\nused with implementation specific semantics."
      additionalProperties: {}
      description: "`Any` contains an arbitrary serialized protocol buffer message along with a\nURL that describes the type of the serialized message.\n\nProtobuf library provides support to pack/unpack Any values in the form\nof utility functions or additional generated methods of the Any type.\n\nExample 1: Pack and unpack a message in C++.\n\n    Foo foo = ...;\n    Any any;\n    any.PackFrom(foo);\n    ...\n    if (any.UnpackTo(&foo)) {\n      ...\n    }\n\nExample 2: Pack and unpack a message in Java.\n\n    Foo foo = ...;\n    Any any = Any.pack(foo);\n    ...\n    if (any.is(Foo.class)) {\n      foo = any.unpack(Foo.class);\n    }\n\n Example 3: Pack and unpack a message in Python.\n\n    foo = Foo(...)\n    any = Any()\n    any.Pack(foo)\n    ...\n    if any.Is(Foo.DESCRIPTOR):\n      any.Unpack(foo)\n      ...\n\n Example 4: Pack and unpack a message in Go\n\n     foo := &pb.Foo{...}\n     any, err := ptypes.MarshalAny(foo)\n     ...\n     foo := &pb.Foo{}\n     if err := ptypes.UnmarshalAny(any, foo); err != nil {\n       ...\n     }\n\nThe pack methods provided by protobuf library will by default use\n'type.googleapis.com/full.type.name' as the type URL and the unpack\nmethods only use the fully qualified type name after the last '/'\nin the type URL, for example \"foo.bar.com/x/y.z\" will yield type\nname \"y.z\".\n\n\nJSON\n====\nThe JSON representation of an `Any` value uses the regular\nrepresentation of the deserialized, embedded message, with an\nadditional field `@type` which contains the type URL. Example:\n\n    package google.profile;\n    message Person {\n      string first_name = 1;\n      string last_name = 2;\n    }\n\n    {\n      \"@type\": \"type.googleapis.com/google.profile.Person\",\n      \"firstName\": <string>,\n      \"lastName\": <string>\n    }\n\nIf the embedded message type is well-known and has a custom JSON\nrepresentation, that representation will be embedded adding a field\n`value` which holds the custom JSON in addition to the `@type`\nfield. Example (for message [google.protobuf.Duration][]):\n\n    {\n      \"@type\": \"type.googleapis.com/google.protobuf.Duration\",\n      \"value\": \"1.212s\"\n    }"
    s12.webhooks.v1.TriggerEvent:
      type: string
      enum:
      - TRIGGER_EVENT_INSPECTION_STARTED
      - TRIGGER_EVENT_INSPECTION_UPDATED
      - TRIGGER_EVENT_INSPECTION_COMPLETED
      - TRIGGER_EVENT_INSPECTION_ARCHIVED
      - TRIGGER_EVENT_INSPECTION_UNARCHIVED
      - TRIGGER_EVENT_INSPECTION
      - TRIGGER_EVENT_INSPECTION_METADATA
      - TRIGGER_EVENT_INSPECTION_HAS_STARTED
      - TRIGGER_EVENT_INSPECTION_CLONED
      - TRIGGER_EVENT_INSPECTION_COMPLETED_STATUS
      - TRIGGER_EVENT_INSPECTION_LOCATION
      - TRIGGER_EVENT_INSPECTION_DURATION
      - TRIGGER_EVENT_INSPECTION_ARCHIVED_STATUS
      - TRIGGER_EVENT_INSPECTION_DELETED_STATUS
      - TRIGGER_EVENT_INSPECTION_OWNER
      - TRIGGER_EVENT_INSPECTION_ACCESS
      - TRIGGER_EVENT_INSPECTION_ORGANISATION
      - TRIGGER_EVENT_INSPECTION_ITEM_UPDATED
      - TRIGGER_EVENT_INSPECTION_ITEM_SITE
      - TRIGGER_EVENT_INSPECTION_ITEM_TEXT
      - TRIGGER_EVENT_INSPECTION_ITEM_TEMPERATURE
      - TRIGGER_EVENT_INSPECTION_ITEM_ADDRESS
      - TRIGGER_EVENT_INSPECTION_ITEM_ASSET
      - TRIGGER_EVENT_INSPECTION_ITEM_DATETIME
      - TRIGGER_EVENT_INSPECTION_ITEM_CHECKBOX
      - TRIGGER_EVENT_INSPECTION_ITEM_DYNAMIC_FIELD
      - TRIGGER_EVENT_INSPECTION_ITEM_LIST
      - TRIGGER_EVENT_INSPECTION_ITEM_QUESTION
      - TRIGGER_EVENT_INSPECTION_ITEM_MEDIA
      - TRIGGER_EVENT_INSPECTION_ITEM_DRAWING
      - TRIGGER_EVENT_INSPECTION_ITEM_SIGNATURE
      - TRIGGER_EVENT_INSPECTION_ITEM_SLIDER
      - TRIGGER_EVENT_INSPECTION_ITEM_NOTE
      - TRIGGER_EVENT_ACTION_CREATED
      - TRIGGER_EVENT_ACTION_TITLE_UPDATED
      - TRIGGER_EVENT_ACTION_DESCRIPTION_UPDATED
      - TRIGGER_EVENT_ACTION_DATE_DUE_UPDATED
      - TRIGGER_EVENT_ACTION_STATUS_UPDATED
      - TRIGGER_EVENT_ACTION_PRIORITY_UPDATED
      - TRIGGER_EVENT_ACTION_COLLABORATORS_REMOVED
      - TRIGGER_EVENT_ACTION_COLLABORATORS_ADDED
      - TRIGGER_EVENT_ACTION_CATEGORY_UPDATED
      - TRIGGER_EVENT_ACTION_SITE_UPDATED
      - TRIGGER_EVENT_ACTION_DELETED
      - TRIGGER_EVENT_ACTION_ORG_UPDATED
      - TRIGGER_EVENT_ACTION_COLLABORATORS_UPDATED
      - TRIGGER_EVENT_ACTION_ASSET_UPDATED
      - TRIGGER_EVENT_ACTION_LABELS_UPDATED
      - TRIGGER_EVENT_ACTION_UPDATED
      - TRIGGER_EVENT_INCIDENT_CREATED
      - TRIGGER_EVENT_INCIDENT_TITLE_UPDATED
      - TRIGGER_EVENT_INCIDENT_DESCRIPTION_UPDATED
      - TRIGGER_EVENT_INCIDENT_DATE_DUE_UPDATED
      - TRIGGER_EVENT_INCIDENT_STATUS_UPDATED
      - TRIGGER_EVENT_INCIDENT_PRIORITY_UPDATED
      - TRIGGER_EVENT_INCIDENT_COLLABORATORS_REMOVED
      - TRIGGER_EVENT_INCIDENT_COLLABORATORS_ADDED
      - TRIGGER_EVENT_INCIDENT_CATEGORY_UPDATED
      - TRIGGER_EVENT_INCIDENT_SITE_UPDATED
      - TRIGGER_EVENT_INCIDENT_DELETED
      - TRIGGER_EVENT_INCIDENT_ORG_UPDATED
      - TRIGGER_EVENT_INCIDENT_COLLABORATORS_UPDATED
      - TRIGGER_EVENT_INCIDENT_UPDATED
      - TRIGGER_EVENT_MEDIA_UPLOADED
      - TRIGGER_EVENT_TRAINING_COURSE_OPENED
      - TRIGGER_EVENT_TRAINING_COURSE_COMPLETED
      - TRIGGER_EVENT_TRAINING_COURSE_EXPIRED
      - TRIGGER_EVENT_TRAINING_COURSE_RESET
      - TRIGGER_EVENT_TRAINING_LESSON_OPENED
      - TRIGGER_EVENT_TRAINING_LESSON_COMPLETED
      - TRIGGER_EVENT_TRAINING_COURSE_CREATED
      - TRIGGER_EVENT_TRAINING_COURSE_UPDATED
      - TRIGGER_EVENT_TRAINING_COURSE_PUBLISHED
      - TRIGGER_EVENT_TRAINING_COURSE_REPUBLISHED
      - TRIGGER_EVENT_TRAINING_COURSE_UNPUBLISHED
      - TRIGGER_EVENT_TRAINING_COURSE_DELETED
      - TRIGGER_EVENT_TRAINING_COURSE_ENROLLED
      - TRIGGER_EVENT_TRAINING_QUIZ_SESSION_STARTED
      - TRIGGER_EVENT_TRAINING_QUIZ_SESSION_RETRIED
      - TRIGGER_EVENT_TRAINING_LESSON_CREATED
      - TRIGGER_EVENT_TRAINING_LESSON_UPDATED
      - TRIGGER_EVENT_TRAINING_LESSON_PUBLISHED
      - TRIGGER_EVENT_TRAINING_LESSON_UNPUBLISHED
      - TRIGGER_EVENT_TRAINING_LESSON_DELETED
      - TRIGGER_EVENT_ATTENDANCE_SIGNED_ON
      - TRIGGER_EVENT_ATTENDANCE_SIGNED_OFF
      description: "- TRIGGER_EVENT_INSPECTION_STARTED: @deprecated use TRIGGER_EVENT_INSPECTION_HAS_STARTED instead\n - TRIGGER_EVENT_INSPECTION_UPDATED: @deprecated use TRIGGER_EVENT_INSPECTION_METADATA or\nTRIGGER_EVENT_INSPECTION_ITEM_UPDATED instead\n - TRIGGER_EVENT_INSPECTION_COMPLETED: @deprecated use TRIGGER_EVENT_INSPECTION_COMPLETED_STATUS instead\n - TRIGGER_EVENT_INSPECTION_ARCHIVED: @deprecated use TRIGGER_EVENT_INSPECTION_ARCHIVED_STATUS instead\n - TRIGGER_EVENT_INSPECTION_UNARCHIVED: @deprecated use TRIGGER_EVENT_INSPECTION_ARCHIVED_STATUS instead\n - TRIGGER_EVENT_INSPECTION: TRIGGER_EVENT_INSPECTION is a bundle trigger event\nequivalent to subscribing to all inspection events\n - TRIGGER_EVENT_INSPECTION_METADATA: TRIGGER_EVENT_INSPECTION_METADATA is a bundle trigger event\nequivalent to subscribing to 8-17 individually\n - TRIGGER_EVENT_INSPECTION_ITEM_UPDATED: TRIGGER_EVENT_INSPECTION_ITEM_UPDATED is a bundle trigger event\nequivalent to subscribing to 19-33 individually\n - TRIGGER_EVENT_ACTION_CREATED: Action Created\n - TRIGGER_EVENT_ACTION_TITLE_UPDATED: Action title updated\n - TRIGGER_EVENT_ACTION_DESCRIPTION_UPDATED: Action description updated\n - TRIGGER_EVENT_ACTION_DATE_DUE_UPDATED: Action Due Date Updated\n - TRIGGER_EVENT_ACTION_STATUS_UPDATED: Action Status Updated\n - TRIGGER_EVENT_ACTION_PRIORITY_UPDATED: Action Priority Updated\n - TRIGGER_EVENT_ACTION_COLLABORATORS_REMOVED: Action Collaborators Removed\n - TRIGGER_EVENT_ACTION_COLLABORATORS_ADDED: Action Collaborators Added\n - TRIGGER_EVENT_ACTION_CATEGORY_UPDATED: Action Category Updated\n - TRIGGER_EVENT_ACTION_SITE_UPDATED: Action Site Updated\n - TRIGGER_EVENT_ACTION_DELETED: Action Deleted\n - TRIGGER_EVENT_ACTION_ORG_UPDATED: Action Organisation Updated\n - TRIGGER_EVENT_ACTION_COLLABORATORS_UPDATED: Action Collaborators Updated\n - TRIGGER_EVENT_ACTION_ASSET_UPDATED: Action Asset Updated\n - TRIGGER_EVENT_ACTION_LABELS_UPDATED: Action Labels Updated\n - TRIGGER_EVENT_ACTION_UPDATED: Any action field updated\n - TRIGGER_EVENT_INCIDENT_CREATED: Incident (a.k.a. Issue) created\n - TRIGGER_EVENT_INCIDENT_TITLE_UPDATED: Incident title updated\n - TRIGGER_EVENT_INCIDENT_DESCRIPTION_UPDATED: Incident description updated\n - TRIGGER_EVENT_INCIDENT_DATE_DUE_UPDATED: Incident Due Date Updated\n - TRIGGER_EVENT_INCIDENT_STATUS_UPDATED: Incident Status Updated\n - TRIGGER_EVENT_INCIDENT_PRIORITY_UPDATED: Incident Priority Updated\n - TRIGGER_EVENT_INCIDENT_COLLABORATORS_REMOVED: Incident Collaborators Removed\n - TRIGGER_EVENT_INCIDENT_COLLABORATORS_ADDED: Incident Collaborators Added\n - TRIGGER_EVENT_INCIDENT_CATEGORY_UPDATED: Incident Category Updated\n - TRIGGER_EVENT_INCIDENT_SITE_UPDATED: Incident Site Updated\n - TRIGGER_EVENT_INCIDENT_DELETED: Incident Deleted\n - TRIGGER_EVENT_INCIDENT_ORG_UPDATED: Incident Organisation Updated\n - TRIGGER_EVENT_INCIDENT_COLLABORATORS_UPDATED: Incident Collaborators Updated\n - TRIGGER_EVENT_INCIDENT_UPDATED: Any incident field updated\n - TRIGGER_EVENT_MEDIA_UPLOADED: Media uploaded\n - TRIGGER_EVENT_TRAINING_COURSE_OPENED: A user has opened a course\n - TRIGGER_EVENT_TRAINING_COURSE_COMPLETED: A user has completed a course\n - TRIGGER_EVENT_TRAINING_COURSE_EXPIRED: A user's course completion has expired\n - TRIGGER_EVENT_TRAINING_COURSE_RESET: A user's course progress has been reset\n - TRIGGER_EVENT_TRAINING_LESSON_OPENED: A user has opened a lesson\n - TRIGGER_EVENT_TRAINING_LESSON_COMPLETED: A user has completed a lesson\n - TRIGGER_EVENT_TRAINING_COURSE_CREATED: A course was created\n - TRIGGER_EVENT_TRAINING_COURSE_UPDATED: A course was updated\n - TRIGGER_EVENT_TRAINING_COURSE_PUBLISHED: A course was published\n - TRIGGER_EVENT_TRAINING_COURSE_REPUBLISHED: A course was re-published\n - TRIGGER_EVENT_TRAINING_COURSE_UNPUBLISHED: A course was unpublished\n - TRIGGER_EVENT_TRAINING_COURSE_DELETED: A course was deleted\n - TRIGGER_EVENT_TRAINING_COURSE_ENROLLED: A user was enrolled in a course\n - TRIGGER_EVENT_TRAINING_QUIZ_SESSION_STARTED: A user has started a quiz session\n - TRIGGER_EVENT_TRAINING_QUIZ_SESSION_RETRIED: A user has retried a quiz session\n - TRIGGER_EVENT_TRAINING_LESSON_CREATED: A lesson was created\n - TRIGGER_EVENT_TRAINING_LESSON_UPDATED: A lesson was updated\n - TRIGGER_EVENT_TRAINING_LESSON_PUBLISHED: A lesson was published\n - TRIGGER_EVENT_TRAINING_LESSON_UNPUBLISHED: A lesson was unpublished\n - TRIGGER_EVENT_TRAINING_LESSON_DELETED: A lesson was deleted\n - TRIGGER_EVENT_ATTENDANCE_SIGNED_ON: A worker signed on to a site: their stay opened.\n - TRIGGER_EVENT_ATTENDANCE_SIGNED_OFF: A worker signed off a site, moved to another site, or the register closed\ntheir stay. The payload distinguishes an observed sign-off from an inferred\none."
      title: Webhook trigger event types
    s12.webhooks.v1.WebhooksService.UpdateWebhookBody:
      type: object
      properties:
        trigger_events:
          type: array
          items:
            $ref: '#/components/schemas/s12.webhooks.v1.TriggerEvent'
          description: The list of event types to trigger the webhook.
        url:
          type: string
          description: The webhook destination URL.
        enabled:
          type: boolean
          description: The enabled state of the webhook. True = enabled.
      description: The parameters for `UpdateWebhook`
      title: UpdateWebhookRequest
    s12.webhooks.v1.UpdateWebhookResponse:
      type: object
      properties:
        webhook:
          description: The updated webhook.
          allOf:
          - $ref: '#/components/schemas/s12.webhooks.v1.WebhookResponse'
      description: Result returned from `UpdateWebhook`
      title: UpdateWebhookResponse
    s12.webhooks.v1.GetTokenResponse:
      type: object
      properties:
        token:
          type: string
          description: Organisation Secret token.
      description: Result returned from `GetToken`
      title: GetTokenResponse
    s12.webhooks.v1.GenerateTokenResponse:
      type: object
      properties:
        token:
          type: string
      description: Result returned from `GenerateToken`
      title: GenerateTokenResponse
    s12.webhooks.v1.DeleteWebhookResponse:
      type: object
      description: Result returned from `DeleteWebhook`
      title: DeleteWebhookResponse
    s12.webhooks.v1.CreateWebhookRequest:
      type: object
      properties:
        trigger_events:
          type: array
          items:
            $ref: '#/components/schemas/s12.webhooks.v1.TriggerEvent'
          description: The list of event types to trigger the webhook. Cannot be empty.
        url:
          type: string
          description: The webhook destination URL.
      description: The parameters for `CreateWebhook`
      title: CreateWebhookRequest
      required:
      - trigger_events
      - url
    s12.webhooks.v1.GetWebhookResponse:
      type: object
      properties:
        webhook:
          description: The webhook requested by the unique identifier.
          allOf:
          - $ref: '#/components/schemas/s12.webhooks.v1.WebhookResponse'
      description: Result returned from `GetWebhook`
      title: GetWebhookResponse
    s12.webhooks.v1.CreateWebhookResponse:
      type: object
      properties:
        webhook:
          description: The newly registered webhook upon creation.
          allOf:
          - $ref: '#/components/schemas/s12.webhooks.v1.WebhookResponse'
      description: Result returned from `CreateWebhook`
      title: CreateWebhookResponse
    google.rpc.Status:
      type: object
      properties:
        code:
          type: integer
          format: int32
        message:
          type: string
        details:
          type: array
          items:
            type: object
            $ref: '#/components/schemas/google.protobuf.Any'
    s12.webhooks.v1.WebhookResponse:
      type: object
      properties:
        webhook_id:
          type: string
          description: Webhook unique identifier.
        trigger_events:
          type: array
          items:
            $ref: '#/components/schemas/s12.webhooks.v1.TriggerEvent'
          description: List of event types to trigger the webhook.
        url:
          type: string
          description: The webhook destination URL.
        user_id:
          type: string
          description: The unique identifier of the user registering the webhook.
        organisation_id:
          type: string
          description: The unique identifier of the organisation registering the webhook.
        enabled:
          type: boolean
          description: value = True if the webhook is enabled.
        created_at:
          type: string
          format: date-time
          description: Date and time of when the webhook was created.
        updated_at:
          type: string
          format: date-time
          description: Date and time of when the webhook was last updated.
    s12.webhooks.v1.ListWebhooksResponse:
      type: object
      properties:
        webhook:
          type: array
          items:
            type: object
            $ref: '#/components/schemas/s12.webhooks.v1.WebhookResponse'
          description: A list of webhooks.
      description: Result returned from `ListWebhooks`
      title: ListWebhooksResponse
  securitySchemes:
    BearerAuthentication:
      type: http
      scheme: bearer
externalDocs:
  description: How to generate an API Token
  url: https://help.mitti.com/en-US/000007/
x-provenance:
  method: searched
  source: https://developer.mitti.com/reference
  harvested: '2026-10-14'
  tool: harvest-readme-openapi.py
  note: Assembled verbatim from the OpenAPI definition ReadMe embeds in each operation page of the provider's developer portal; paths and components merged by API title, nothing authored.
  assembled_from:
  - https://developer.mitti.com/reference/actionsservice_createaction.md
  - https://developer.mitti.com/reference/actionsservice_createactionschedule.md
  - https://developer.mitti.com/reference/actionsservice_createactionsharedlink.md
  - https://developer.mitti.com/reference/actionsservice_deleteactions.md
  - https://developer.mitti.com/reference/actionsservice_getaction.md
  - https://developer.mitti.com/reference/actionsservice_getactions.md
  - https://developer.mitti.com/reference/actionsservice_getactionsharedlink.md
  - https://developer.mitti.com/reference/actionsservice_revokeactionsharedlink.md
  - https://developer.mitti.com/reference/actionsservice_updateactionlabels.md
  - https://developer.mitti.com/reference/actionsservice_updateasset.md
  - https://developer.mitti.com/reference/actionsservice_updateassignees.md
  - https://developer.mitti.com/reference/actionsservice_updatedescription.md
  - https://developer.mitti.com/reference/actionsservice_updatedueat.md
  - https://developer.mitti.com/reference/actionsservice_updatepriority.md
  - https://developer.mitti.com/reference/actionsservice_updatesite.md
  - https://developer.mitti.com/reference/actionsservice_updatestatus.md
  - https://developer.mitti.com/reference/actionsservice_updatetitle.md
  - https://developer.mitti.com/reference/answerservice_answerasset.md
  - https://developer.mitti.com/reference/answerservice_answercheckbox.md
  - https://developer.mitti.com/reference/answerservice_generatedynamicfield.md
  - https://developer.mitti.com/reference/answerservice_getanswersforinspection.md
  - https://developer.mitti.com/reference/assetsservice_archiveasset.md
  - https://developer.mitti.com/reference/assetsservice_bulkcreateassets.md
  - https://developer.mitti.com/reference/assetsservice_bulkupdateassets.md
  - https://developer.mitti.com/reference/assetsservice_createasset.md
  - https://developer.mitti.com/reference/assetsservice_deleteasset.md
  - https://developer.mitti.com/reference/assetsservice_getasset.md
  - https://developer.mitti.com/reference/assetsservice_getassetbycode.md
  - https://developer.mitti.com/reference/assetsservice_listassets.md
  - https://developer.mitti.com/reference/assetsservice_lookupassetsbyfield.md
  - https://developer.mitti.com/reference/assetsservice_restorearchivedasset.md
  - https://developer.mitti.com/reference/assetsservice_setassetfieldvalues.md
  - https://developer.mitti.com/reference/assetsservice_updateasset.md
  - https://developer.mitti.com/reference/assetsservice_updateassetlocation.md
  - https://developer.mitti.com/reference/companydocumentsservice_deletecompanydocumenttype.md
  - https://developer.mitti.com/reference/companydocumentsservice_listcompanydocuments.md
  - https://developer.mitti.com/reference/companydocumentsservice_listcompanydocumenttypes.md
  - https://developer.mitti.com/reference/contractorcompanytypesservice_getcompanytype.md
  - https://developer.mitti.com/reference/contractorcompanytypesservice_listcompanytypes.md
  - https://developer.mitti.com/reference/contractorcompanytypesservice_listcompanytypesmetrics.md
  - https://developer.mitti.com/reference/contractorsservice_createcontractorcompany.md
  - https://developer.mitti.com/reference/contractorsservice_deletecontractorcompany.md
  - https://developer.mitti.com/reference/contractorsservice_getcontractorcompany.md
  - https://developer.mitti.com/reference/contractorsservice_listcompanyusermetadata.md
  - https://developer.mitti.com/reference/contractorsservice_listcontractorcompanies.md
  - https://developer.mitti.com/reference/contractorsservice_updatecontractorcompany.md
  - https://developer.mitti.com/reference/customerconfigurationservice_createcustomfield.md
  - https://developer.mitti.com/reference/customerconfigurationservice_createtasktype.md
  - https://developer.mitti.com/reference/customerconfigurationservice_deleteactionlabels.md
  - https://developer.mitti.com/reference/customerconfigurationservice_deletecustomfield.md
  - https://developer.mitti.com/reference/customerconfigurationservice_deletetasktype.md
  - https://developer.mitti.com/reference/customerconfigurationservice_getactionlabels.md
  - https://developer.mitti.com/reference/customerconfigurationservice_getcategories.md
  - https://developer.mitti.com/reference/customerconfigurationservice_getorgtasktypeunmappedfields.md
  - https://developer.mitti.com/reference/customerconfigurationservice_gettasktype.md
  - https://developer.mitti.com/reference/customerconfigurationservice_gettasktypecustomfields.md
  - https://developer.mitti.com/reference/customerconfigurationservice_gettasktypes.md
  - https://developer.mitti.com/reference/customerconfigurationservice_mapfieldtotasktype.md
  - https://developer.mitti.com/reference/customerconfigurationservice_renamecustomfield.md
  - https://developer.mitti.com/reference/customerconfigurationservice_renamecustomfieldoptions.md
  - https://developer.mitti.com/reference/customerconfigurationservice_renametasktype.md
  - https://developer.mitti.com/reference/customerconfigurationservice_unmapfieldfromtasktype.md
  - https://developer.mitti.com/reference/customerconfigurationservice_upsertactionlabel.md
  - https://developer.mitti.com/reference/directory_addusersfoldersassociations.md
  - https://developer.mitti.com/reference/directory_createfolder.md
  - https://developer.mitti.com/reference/directory_deletefolders.md
  - https://developer.mitti.com/reference/directory_getallusersbyfolder.md
  - https://developer.mitti.com/reference/directory_getfolder.md
  - https://developer.mitti.com/reference/directory_getfolderidsforuser.md
  - https://developer.mitti.com/reference/directory_getfolders.md
  - https://developer.mitti.com/reference/directory_getfoldersbyparent.md
  - https://developer.mitti.com/reference/directory_getinheritedusersbyfolder.md
  - https://developer.mitti.com/reference/directory_getorglabels.md
  - https://developer.mitti.com/reference/directory_getusersbyfolder.md
  - https://developer.mitti.com/reference/directory_movefolders.md
  - https://developer.mitti.com/reference/directory_removefoldersassociation.md
  - https://developer.mitti.com/reference/directory_removeusersassociation.md
  - https://developer.mitti.com/reference/directory_searchfolders.md
  - https://developer.mitti.com/reference/directory_updatefolderproperties.md
  - https://developer.mitti.com/reference/documentspublicservice_archiveitem.md
  - https://developer.mitti.com/reference/documentspublicservice_bulkaddfileowners.md
  - https://developer.mitti.com/reference/documentspublicservice_bulkremovefileowners.md
  - https://developer.mitti.com/reference/documentspublicservice_bulkupdatefileowners.md
  - https://developer.mitti.com/reference/documentspublicservice_createfile.md
  - https://developer.mitti.com/reference/documentspublicservice_getfolderchildren.md
  - https://developer.mitti.com/reference/documentspublicservice_linkfiles.md
  - https://developer.mitti.com/reference/documentspublicservice_moveitem.md
  - https://developer.mitti.com/reference/documentspublicservice_searchitems.md
  - https://developer.mitti.com/reference/documentspublicservice_updatefile.md
  - https://developer.mitti.com/reference/documenttypesservice_createdocumenttype.md
  - https://developer.mitti.com/reference/documenttypesservice_deletedocumenttype.md
  - https://developer.mitti.com/reference/documenttypesservice_getdocumenttype.md
  - https://developer.mitti.com/reference/documenttypesservice_listdocumenttypes.md
  - https://developer.mitti.com/reference/documenttypesservice_updatedocumenttype.md
  - https://developer.mitti.com/reference/externalinspectionservice_getinspectiondetails.md
  - https://developer.mitti.com/reference/feedservice_credentials.md
  - https://developer.mitti.com/reference/feedservice_credentialtypes.md
  - https://developer.mitti.com/reference/feedservice_feedactionfields.md
  - https://developer.mitti.com/reference/feedservice_feedactionfields2.md
  - https://developer.mitti.com/reference/feedservice_feedassetsmaintenance.md
  - https://developer.mitti.com/reference/feedservice_feedcontractorcompanies.md
  - https://developer.mitti.com/reference/feedservice_feedcontractorcompanydocuments.md
  - https://developer.mitti.com/reference/feedservice_feedcontractorcompanyusermemberships.md
  - https://developer.mitti.com/reference/feedservice_feedinvestigationdetailfields.md
  - https://developer.mitti.com/reference/feedservice_feedinvestigationfields.md
  - https://developer.mitti.com/reference/feedservice_feedinvestigationrelationships.md
  - https://developer.mitti.com/reference/feedservice_feedinvestigations.md
  - https://developer.mitti.com/reference/feedservice_feedmaintenanceplans.md
  - https://developer.mitti.com/reference/feedservice_feedmaintenanceprograms.md
  - https://developer.mitti.com/reference/feedservice_feedtrainingcourseprogress.md
  - https://developer.mitti.com/reference/fieldsservice_createfield.md
  - https://developer.mitti.com/reference/fieldsservice_deletefield.md
  - https://developer.mitti.com/reference/fieldsservice_listfields.md
  - https://developer.mitti.com/reference/fieldsservice_updatefield.md
  - https://developer.mitti.com/reference/headsupservice_getheadsup.md
  - https://developer.mitti.com/reference/headsupservice_getheadsupcompletioncounts.md
  - https://developer.mitti.com/reference/headsupservice_getheadsupmessages.md
  - https://developer.mitti.com/reference/headsupservice_listheadsupmanage.md
  - https://developer.mitti.com/reference/headsupservice_listheadsupusers.md


# --- truncated at 32 KB (55 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/safetyculture/refs/heads/main/openapi/safetyculture-webhooks-api-openapi.yml