MINE

MINE Webhooks API

The Webhooks API from MINE — 6 operation(s) for webhooks.

GitHub OpenAPI

Operations 7

GET /api/Webhooks/Configurations Get all current webhook configurations
GET /api/Webhooks/Configurations/{id} Get webhook configuration for a specific Id
POST /api/Webhooks/Subscribe Adds a new webhook endpoint
PATCH /api/Webhooks/Subscribe/{id} Update an existing webhook configuration
POST /api/Webhooks/Endpoint Sets webhook endpoint
DELETE /api/Webhooks/Endpoint Disables webhook endpoint
DELETE /api/Webhooks/Unsubscribe/{id} Deletes webhook endpoint

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/mine/refs/heads/main/openapi/mine-webhooks-api-openapi.yml

Other Resources

🔗
DataModel
https://raw.githubusercontent.com/api-evangelist/mine/refs/heads/main/data-model/mine-data-model.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/mine-webhooks-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

mine-webhooks-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: MineOS Aispm Webhooks API
  version: v1.0
servers:
- url: https://api.portal.saymine.com/
  description: MineOS EU API Endpoint
- url: https://api.us.portal.saymine.com/
  description: MineOS US API Endpoint
security:
- Bearer: []
tags:
- name: Webhooks
paths:
  /api/Webhooks/Configurations:
    get:
      tags:
      - Webhooks
      summary: Get all current webhook configurations
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WebhookConfigurationsResponse'
        '400':
          description: Bad Request
        '401':
          description: Unauthorized
  /api/Webhooks/Configurations/{id}:
    get:
      tags:
      - Webhooks
      summary: Get webhook configuration for a specific Id
      parameters:
      - name: id
        in: path
        description: Use 'default' for main Id or UUID
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WebhookConfigurationResponse'
        '400':
          description: Bad Request
        '401':
          description: Unauthorized
        '404':
          description: Not Found
  /api/Webhooks/Subscribe:
    post:
      tags:
      - Webhooks
      summary: Adds a new webhook endpoint
      description: 'This will always add a new webhook endpoint, even if a similar webhook url has already been configured

        Max number of webhook configurations is 30

        Supported event types: TicketCreated, TprmTrigger, TicketClosed'
      requestBody:
        description: ''
        content:
          application/json-patch+json:
            schema:
              $ref: '#/components/schemas/WebhookSubscriberPostRequest'
          application/json:
            schema:
              $ref: '#/components/schemas/WebhookSubscriberPostRequest'
          text/json:
            schema:
              $ref: '#/components/schemas/WebhookSubscriberPostRequest'
          application/*+json:
            schema:
              $ref: '#/components/schemas/WebhookSubscriberPostRequest'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: string
        '400':
          description: Bad Request
        '401':
          description: Unauthorized
  /api/Webhooks/Subscribe/{id}:
    patch:
      tags:
      - Webhooks
      summary: Update an existing webhook configuration
      parameters:
      - name: id
        in: path
        description: ''
        required: true
        schema:
          type: string
      requestBody:
        description: ''
        content:
          application/json-patch+json:
            schema:
              $ref: '#/components/schemas/WebhookSubscribeRequest'
          application/json:
            schema:
              $ref: '#/components/schemas/WebhookSubscribeRequest'
          text/json:
            schema:
              $ref: '#/components/schemas/WebhookSubscribeRequest'
          application/*+json:
            schema:
              $ref: '#/components/schemas/WebhookSubscribeRequest'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WebhookConfigurationResponse'
        '400':
          description: Bad Request
        '401':
          description: Unauthorized
        '404':
          description: Not Found
  /api/Webhooks/Endpoint:
    post:
      tags:
      - Webhooks
      summary: Sets webhook endpoint
      description: This will replace any existing endpoint that is currently set, either from the UI or a previous API call.
      parameters:
      - name: url
        in: query
        description: The URL of the new endpoint. Will replace any existing endpoint.
        schema:
          type: string
      requestBody:
        description: A list of enabled events to be sent to the endpoint.
        content:
          application/json-patch+json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/WebhookEventType'
          application/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/WebhookEventType'
          text/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/WebhookEventType'
          application/*+json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/WebhookEventType'
      responses:
        '200':
          description: Success
        '400':
          description: Bad Request
        '401':
          description: Unauthorized
    delete:
      tags:
      - Webhooks
      summary: Disables webhook endpoint
      description: This will disable any existing endpoint that is currently set, either from the UI or a previous API call.
      responses:
        '200':
          description: Success
        '400':
          description: Bad Request
        '401':
          description: Unauthorized
  /api/Webhooks/Unsubscribe/{id}:
    delete:
      tags:
      - Webhooks
      summary: Deletes webhook endpoint
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success
        '400':
          description: Bad Request
        '401':
          description: Unauthorized
components:
  schemas:
    WebhookEventType:
      enum:
      - Unknown
      - TicketCreated
      - WebhookSlim
      - CustomIntegration
      - SystemCreated
      - EmployeeInactive
      - TprmTrigger
      - TicketClosed
      - ExitRequireAttention
      - SystemStatusChange
      type: string
    WebhookConfigurationsResponse:
      type: object
      properties:
        items:
          type:
          - object
          - 'null'
          additionalProperties:
            $ref: '#/components/schemas/WebhookConfigurationResponse'
      additionalProperties: false
    WebhookConfigurationResponse:
      type: object
      properties:
        id:
          type:
          - string
          - 'null'
        enabled:
          type: boolean
        createdAt:
          type: string
          format: date-time
        lastModified:
          type:
          - string
          - 'null'
          format: date-time
        endpoint:
          type:
          - string
          - 'null'
        headerName:
          type:
          - string
          - 'null'
        headerValue:
          type:
          - string
          - 'null'
        supportedEventTypes:
          uniqueItems: true
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/WebhookEventType'
      additionalProperties: false
    WebhookSubscribeRequest:
      required:
      - supportedEventTypes
      - url
      type: object
      properties:
        url:
          maxLength: 2048
          minLength: 1
          type: string
          description: The URL to which the webhook will send the event data.
        supportedEventTypes:
          type: array
          items:
            $ref: '#/components/schemas/WebhookEventType'
          description: The list of event types that the webhook will subscribe to.
        headerName:
          maxLength: 50
          type:
          - string
          - 'null'
          description: Custom Header Name
        headerValue:
          maxLength: 50
          type:
          - string
          - 'null'
          description: Custom Header Value
      additionalProperties: false
    WebhookSubscriberPostRequest:
      required:
      - supportedEventTypes
      - url
      type: object
      properties:
        url:
          maxLength: 2048
          minLength: 1
          type: string
          description: The URL to which the webhook will send the event data.
        supportedEventTypes:
          type: array
          items:
            $ref: '#/components/schemas/WebhookEventType'
          description: The list of event types that the webhook will subscribe to.
        headerName:
          maxLength: 50
          type:
          - string
          - 'null'
          description: Custom Header Name
        headerValue:
          maxLength: 50
          type:
          - string
          - 'null'
          description: Custom Header Value
        id:
          type:
          - string
          - 'null'
          description: The Id for the desired webhook subscription.
      additionalProperties: false
  securitySchemes:
    Bearer:
      type: apiKey
      description: "Authorization header using the Bearer scheme. \n\nEnter 'Bearer' [space] and then your API Key in the text input below.\n\nExample: 'Bearer 12345abcdef'"
      name: Authorization
      in: header