mammoth-io Webhooks API

openapi: 3.2.0
info:
  title: Mammoth Io Webhooks API
  version: 0.1.0
  contact:
    name: Mammoth Analytics
    url: https://mammoth.io
    email: support@mammoth.io
  description: 'Operations tagged Webhooks across 2 of this provider''s published API definitions: app.mammoth.io-openapi.json, mammoth-io-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: /api/v2
security:
- bearerAuth: []
- apiKey: []
  apiSecret: []
  workspaceId: []
tags:
- name: Webhooks
paths:
  /workspaces/{workspace_id}/projects/{project_id}/webhooks:
    get:
      tags:
      - Webhooks
      summary: List webhooks
      description: Returns list of webhook details. Query parameters can be used to optimize the response.
      operationId: ListWebhooks
      parameters:
      - name: workspace_id
        in: path
        schema:
          type: integer
          minimum: 1.0
          title: Workspace ID
          description: Workspace refers to a collection of projects. Workspace ID is unique identifier for workspace.
          examples:
          - 4
        description: Workspace refers to a collection of projects. Workspace ID is unique identifier for workspace.
        required: true
        deprecated: false
        examples:
          workspace_id-example-1:
            summary: Sample workspace ID
            value: 4
      - name: project_id
        in: path
        schema:
          type: integer
          minimum: 1.0
          title: Project ID
          description: Project ID of the workspace
          examples:
          - 4
        description: Project ID of the workspace
        required: true
        deprecated: false
        examples:
          project_id-example-1:
            summary: Sample project ID
            value: 4
      - name: fields
        in: query
        schema:
          oneOf:
          - type: string
            default: __standard
          - type: 'null'
          title: Fields
          description: Fields to be returned in a comma-separated format may include id, name, ds_id, url.
          default: __standard
          examples:
          - id,name
          - __full
          - __standard
          - __min
        description: Fields to be returned in a comma-separated format may include id, name, ds_id, url.
        required: false
        deprecated: false
        allowEmptyValue: false
        allowReserved: false
        examples:
          fields-example-1:
            summary: Return only id and name
            value: id,name
          fields-example-2:
            summary: Return full representation of the ds_config. Full representation includes id,name,mode,uri,ds_id,origins
            value: __full
          fields-example-3:
            summary: Return standard representation of the ds_config. standard representation includes id,name,mode,uri,ds_id,origins
            value: __standard
          fields-example-4:
            summary: Return minimal representation of the ds_config. Minimal representation includes id,name,mode,uri,ds_id
            value: __min
      - name: id
        in: query
        schema:
          type: string
          title: Comma separated list of webhook ids to get webhooks
          description: Track multiple webhook ids, comma separated
          default: ''
          examples:
          - 1,2,3
        description: Track multiple webhook ids, comma separated
        required: false
        deprecated: false
        allowEmptyValue: false
        allowReserved: false
        examples:
          id-example-1:
            summary: Returns details of webhook ids 1, 2 and 3
            value: 1,2,3
      - name: name
        in: query
        schema:
          oneOf:
          - type: string
            default: ''
          - type: 'null'
          title: Comma separated list of webhook names to get webhooks
          description: Track multiple webhook names, comma separated
          default: ''
          examples:
          - webhook_name1,webhook_name2,webhook_name3
        description: Track multiple webhook names, comma separated
        required: false
        deprecated: false
        allowEmptyValue: false
        allowReserved: false
        examples:
          name-example-1:
            summary: Returns details of webhook containing names webhook_name1, webhook_name2 and webhook_name3
            value: webhook_name1,webhook_name2,webhook_name3
      - name: ds_id
        in: query
        schema:
          type: string
          title: Comma separated list of webhook ds ids to get webhooks
          description: Track multiple webhook ds ids, comma separated
          default: ''
          examples:
          - 1,2,3
        description: Track multiple webhook ds ids, comma separated
        required: false
        deprecated: false
        allowEmptyValue: false
        allowReserved: false
        examples:
          ds_id-example-1:
            summary: Returns details of webhook ds ids 1, 2 and 3
            value: 1,2,3
      - name: mode
        in: query
        schema:
          oneOf:
          - type: string
            default: ''
          - type: 'null'
          title: Comma separated list of webhook modes to get webhooks
          description: Track multiple webhook modes, comma separated
          default: ''
          examples:
          - combine,replace
        description: Track multiple webhook modes, comma separated
        required: false
        deprecated: false
        allowEmptyValue: false
        allowReserved: false
        examples:
          mode-example-1:
            summary: Returns details of webhook containing mode combine and replace
            value: combine,replace
      - name: limit
        in: query
        schema:
          type: integer
          maximum: 100.0
          minimum: 0.0
          title: Limit
          description: Max number of result to return
          default: 50
          examples:
          - 10
        description: Max number of result to return
        required: false
        deprecated: false
        allowEmptyValue: false
        allowReserved: false
        examples:
          limit-example-1:
            summary: Limit returned result count to 10
            value: 10
      - name: offset
        in: query
        schema:
          type: integer
          minimum: 0.0
          title: Offset
          description: Distance from the beginning of the list of results
          default: 0
          examples:
          - 10
        description: Distance from the beginning of the list of results
        required: false
        deprecated: false
        allowEmptyValue: false
        allowReserved: false
        examples:
          offset-example-1:
            summary: Start from 10th result
            value: 10
      - name: sort
        in: query
        schema:
          oneOf:
          - type: string
            default: (id:asc)
          - type: 'null'
          title: Sort
          description: Sort the webhooks based on the fields
          default: (id:asc)
          examples:
          - (id:asc),(name:asc)
        description: Sort the webhooks based on the fields
        required: false
        deprecated: false
        allowEmptyValue: false
        allowReserved: false
        examples:
          sort-example-1:
            summary: Sort the webhooks based on id and name fields
            value: (id:asc),(name:asc)
      responses:
        '200':
          description: List webhooks
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WebhooksList'
        '400':
          description: Bad Request
        '401':
          description: Authorization error
      deprecated: false
    post:
      tags:
      - Webhooks
      summary: Create a webhook
      description: Create a webhook dataset.
      operationId: CreateAWebhook
      parameters:
      - name: workspace_id
        in: path
        schema:
          type: integer
          minimum: 1.0
          title: Workspace ID
          description: Workspace refers to a collection of projects. Workspace ID is unique identifier for workspace.
          examples:
          - 4
        description: Workspace refers to a collection of projects. Workspace ID is unique identifier for workspace.
        required: true
        deprecated: false
        examples:
          workspace_id-example-1:
            summary: Sample workspace ID
            value: 4
      - name: project_id
        in: path
        schema:
          type: integer
          minimum: 1.0
          title: Project ID
          description: Project ID of the workspace
          examples:
          - 4
        description: Project ID of the workspace
        required: true
        deprecated: false
        examples:
          project_id-example-1:
            summary: Sample project ID
            value: 4
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/WebhookSpec'
        required: true
      responses:
        '201':
          description: Document created, URL follows
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WebhookDetails'
        '400':
          description: Bad request syntax or unsupported method
          content:
            application/json:
              schema:
                oneOf:
                - properties:
                    status_code:
                      type: integer
                    detail:
                      type: string
                    extra:
                      additionalProperties: {}
                      type:
                      - 'null'
                      - object
                      - array
                  type: object
                  required:
                  - detail
                  - status_code
                  description: Client Error
                  examples:
                  - status_code: 400
                    detail: Bad Request
                    extra: {}
                - properties:
                    status_code:
                      type: integer
                    detail:
                      type: string
                    extra:
                      additionalProperties: {}
                      type:
                      - 'null'
                      - object
                      - array
                  type: object
                  required:
                  - detail
                  - status_code
                  description: Validation Exception
                  examples:
                  - status_code: 400
                    detail: Bad Request
                    extra: {}
      deprecated: false
    servers:
    - url: /api/v2
  /workspaces/{workspace_id}/projects/{project_id}/webhooks/{webhook_id}:
    get:
      tags:
      - Webhooks
      summary: Get webhook details
      description: Returns webhook details. Query parameters can be used to optimize the response.
      operationId: GetWebhookDetails
      parameters:
      - name: workspace_id
        in: path
        schema:
          type: integer
          minimum: 1.0
          title: Workspace ID
          description: Workspace refers to a collection of projects. Workspace ID is unique identifier for workspace.
          examples:
          - 4
        description: Workspace refers to a collection of projects. Workspace ID is unique identifier for workspace.
        required: true
        deprecated: false
        examples:
          workspace_id-example-1:
            summary: Sample workspace ID
            value: 4
      - name: project_id
        in: path
        schema:
          type: integer
          minimum: 1.0
          title: Project ID
          description: Project ID of the workspace
          examples:
          - 4
        description: Project ID of the workspace
        required: true
        deprecated: false
        examples:
          project_id-example-1:
            summary: Sample project ID
            value: 4
      - name: webhook_id
        in: path
        schema:
          type: integer
          minimum: 0.0
          title: Webhook ID
          description: ID of the webhook
          examples:
          - 4
        description: ID of the webhook
        required: true
        deprecated: false
        examples:
          webhook_id-example-1:
            summary: Sample webhook ID
            value: 4
      - name: fields
        in: query
        schema:
          oneOf:
          - type: string
            default: __standard
          - type: 'null'
          title: Fields
          description: Fields to be returned in a comma-separated format may include id, name, ds_id, url.
          default: __standard
          examples:
          - id,name
          - __full
          - __standard
          - __min
        description: Fields to be returned in a comma-separated format may include id, name, ds_id, url.
        required: false
        deprecated: false
        allowEmptyValue: false
        allowReserved: false
        examples:
          fields-example-1:
            summary: Return only id and name
            value: id,name
          fields-example-2:
            summary: Return full representation of the ds_config. Full representation includes id,name,mode,uri,ds_id,origins
            value: __full
          fields-example-3:
            summary: Return standard representation of the ds_config. standard representation includes id,name,mode,uri,ds_id,origins
            value: __standard
          fields-example-4:
            summary: Return minimal representation of the ds_config. Minimal representation includes id,name,mode,uri,ds_id
            value: __min
      responses:
        '200':
          description: Get webhook details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WebhookDetails'
        '400':
          description: Bad Request
        '401':
          description: Authorization error
      deprecated: false
    delete:
      tags:
      - Webhooks
      summary: Delete webhook
      description: Deletes given webhook.
      operationId: DeleteWebhook
      parameters:
      - name: workspace_id
        in: path
        schema:
          type: integer
          minimum: 1.0
          title: Workspace ID
          description: Workspace refers to a collection of projects. Workspace ID is unique identifier for workspace.
          examples:
          - 4
        description: Workspace refers to a collection of projects. Workspace ID is unique identifier for workspace.
        required: true
        deprecated: false
        examples:
          workspace_id-example-1:
            summary: Sample workspace ID
            value: 4
      - name: project_id
        in: path
        schema:
          type: integer
          minimum: 1.0
          title: Project ID
          description: Project ID of the workspace
          examples:
          - 4
        description: Project ID of the workspace
        required: true
        deprecated: false
        examples:
          project_id-example-1:
            summary: Sample project ID
            value: 4
      - name: webhook_id
        in: path
        schema:
          type: integer
          minimum: 0.0
          title: Webhook ID
          description: ID of the webhook
          examples:
          - 4
        description: ID of the webhook
        required: true
        deprecated: false
        examples:
          webhook_id-example-1:
            summary: Sample webhook ID
            value: 4
      responses:
        '204':
          description: Request fulfilled, nothing follows
          headers: {}
        '400':
          description: Bad request syntax or unsupported method
          content:
            application/json:
              schema:
                oneOf:
                - properties:
                    status_code:
                      type: integer
                    detail:
                      type: string
                    extra:
                      additionalProperties: {}
                      type:
                      - 'null'
                      - object
                      - array
                  type: object
                  required:
                  - detail
                  - status_code
                  description: Client Error
                  examples:
                  - status_code: 400
                    detail: Bad Request
                    extra: {}
                - properties:
                    status_code:
                      type: integer
                    detail:
                      type: string
                    extra:
                      additionalProperties: {}
                      type:
                      - 'null'
                      - object
                      - array
                  type: object
                  required:
                  - detail
                  - status_code
                  description: Validation Exception
                  examples:
                  - status_code: 400
                    detail: Bad Request
                    extra: {}
      deprecated: false
    patch:
      tags:
      - Webhooks
      summary: Updates the webhook
      description: Updates the webhook with given information.
      operationId: UpdateWebhookConfigurations
      parameters:
      - name: workspace_id
        in: path
        schema:
          type: integer
          minimum: 1.0
          title: Workspace ID
          description: Workspace refers to a collection of projects. Workspace ID is unique identifier for workspace.
          examples:
          - 4
        description: Workspace refers to a collection of projects. Workspace ID is unique identifier for workspace.
        required: true
        deprecated: false
        examples:
          workspace_id-example-1:
            summary: Sample workspace ID
            value: 4
      - name: project_id
        in: path
        schema:
          type: integer
          minimum: 1.0
          title: Project ID
          description: Project ID of the workspace
          examples:
          - 4
        description: Project ID of the workspace
        required: true
        deprecated: false
        examples:
          project_id-example-1:
            summary: Sample project ID
            value: 4
      - name: webhook_id
        in: path
        schema:
          type: integer
          minimum: 0.0
          title: Webhook ID
          description: ID of the webhook
          examples:
          - 4
        description: ID of the webhook
        required: true
        deprecated: false
        examples:
          webhook_id-example-1:
            summary: Sample webhook ID
            value: 4
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/WebhookPatchRequest'
        required: true
      responses:
        '200':
          description: Request fulfilled, document follows
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WebhookDetails'
        '400':
          description: Bad request syntax or unsupported method
          content:
            application/json:
              schema:
                oneOf:
                - properties:
                    status_code:
                      type: integer
                    detail:
                      type: string
                    extra:
                      additionalProperties: {}
                      type:
                      - 'null'
                      - object
                      - array
                  type: object
                  required:
                  - detail
                  - status_code
                  description: Client Error
                  examples:
                  - status_code: 400
                    detail: Bad Request
                    extra: {}
                - properties:
                    status_code:
                      type: integer
                    detail:
                      type: string
                    extra:
                      additionalProperties: {}
                      type:
                      - 'null'
                      - object
                      - array
                  type: object
                  required:
                  - detail
                  - status_code
                  description: Validation Exception
                  examples:
                  - status_code: 400
                    detail: Bad Request
                    extra: {}
      deprecated: false
    servers:
    - url: /api/v2
  /webhooks/data/{webhook_uri}:
    get:
      tags:
      - Webhooks
      summary: Add data to the webhook
      description: Add data to the webhook.
      operationId: AddDataToWebhookUsingGetMethod
      parameters:
      - name: webhook_uri
        in: path
        schema:
          type: string
          minLength: 1
          title: Webhook Key
          description: API key of the webhook
          examples:
          - g7rHe3mUqUGPEpnc4XxeDWJa
        description: API key of the webhook
        required: true
        deprecated: false
        examples:
          webhook_uri-example-1:
            summary: Sample webhook key
            value: g7rHe3mUqUGPEpnc4XxeDWJa
      responses:
        '200':
          description: Success
        '400':
          description: Bad Request
        '401':
          description: Authorization error
      deprecated: false
    post:
      tags:
      - Webhooks
      summary: Add data to webhook
      description: Add data webhook dataset. Query parameters can be used to optimize the response.
      operationId: AddDataToWebhook
      parameters:
      - name: webhook_uri
        in: path
        schema:
          type: string
          minLength: 1
          title: Webhook Key
          description: API key of the webhook
          examples:
          - g7rHe3mUqUGPEpnc4XxeDWJa
        description: API key of the webhook
        required: true
        deprecated: false
        examples:
          webhook_uri-example-1:
            summary: Sample webhook key
            value: g7rHe3mUqUGPEpnc4XxeDWJa
      responses:
        '201':
          description: Document created, URL follows
          headers: {}
          content:
            application/json:
              schema: {}
        '400':
          description: Bad request syntax or unsupported method
          content:
            application/json:
              schema:
                oneOf:
                - properties:
                    status_code:
                      type: integer
                    detail:
                      type: string
                    extra:
                      additionalProperties: {}
                      type:
                      - 'null'
                      - object
                      - array
                  type: object
                  required:
                  - detail
                  - status_code
                  description: Client Error
                  examples:
                  - status_code: 400
                    detail: Bad Request
                    extra: {}
                - properties:
                    status_code:
                      type: integer
                    detail:
                      type: string
                    extra:
                      additionalProperties: {}
                      type:
                      - 'null'
                      - object
                      - array
                  type: object
                  required:
                  - detail
                  - status_code
                  description: Validation Exception
                  examples:
                  - status_code: 400
                    detail: Bad Request
                    extra: {}
      deprecated: false
    servers:
    - url: /api/v2
components:
  schemas:
    WebhookPatchData:
      properties:
        op:
          $ref: '#/components/schemas/webhooks_schema_OpValues'
        path:
          $ref: '#/components/schemas/webhooks_schema_PathValues'
        value:
          oneOf:
          - type: boolean
          - $ref: '#/components/schemas/ModeValues'
          - type: string
          title: Value
          description: Value to update webhook configuration
          examples:
          - value: false
      type: object
      required:
      - op
      - path
      - value
      title: WebhookPatchData
    webhooks_schema_PathValues:
      type: string
      enum:
      - mode
      - origins
      - is_secure
      title: PathValues
      description: Path
      examples:
      - value: is_secure
    ModeValues:
      type: string
      enum:
      - replace
      - combine
      title: ModeValues
      description: Mode of the webhook
      default: replace
      examples:
      - value: combine
    webhooks_schema_OpValues:
      type: string
      enum:
      - replace
      title: OpValues
      description: Operation
      examples:
      - value: replace
    WebhookSpec:
      properties:
        folder_resource_id:
          oneOf:
          - type: string
          - type: 'null'
          title: Folder resource id
          description: Folder resource id
          examples:
          - value: label_1363
        name:
          type: string
          title: Name
          description: Name of the webhook
          default: Generic Webhook
          examples:
          - value: test
        mode:
          $ref: '#/components/schemas/ModeValues'
        origins:
          type: string
          title: Origins
          description: Origins
          default: '*'
          examples:
          - value: '*'
        is_secure:
          type: boolean
          title: Is secure
          description: Is secure
          default: false
          examples:
          - value: true
      type: object
      required: []
      title: WebhookSpec
      description: create webhook
      examples:
      - folder_resource_id: label_1363
        name: test
        mode: combine
    WebhookStandardSchema:
      properties:
        id:
          type: integer
          title: ID
          description: ID of the webhook
          examples:
          - value: 8
        name:
          type: string
          minLength: 1
          title: Name
          description: Name of the webhook
          examples:
          - value: test
        mode:
          $ref: '#/components/schemas/ModeValues'
        uri:
          type: string
          minLength: 1
          title: URL
          description: URL of the webhook
          examples:
          - value: /webhook/data/nHC1zIl97JzgDMopgcfpOgLV
        ds_id:
          type: integer
          title: DS ID
          description: DS ID of the source
          examples:
          - value: 535
        origins:
          oneOf:
          - type: string
          - type: 'null'
          title: Origins
          description: Origins
          examples:
          - value: '*'
        secret:
          oneOf:
          - type: string
          - type: 'null'
          title: Secret
          description: Secret
          examples:
          - value: V36QXDxGiwSa
      type: object
      required:
      - ds_id
      - id
      - mode
      - name
      - uri
      title: WebhookStandardSchema
    WebhookDetails:
      properties:
        webhook:
          $ref: '#/components/schemas/WebhookStandardSchema'
      type: object
      required:
      - webhook
      title: WebhookDetails
    WebhooksList:
      properties:
        webhooks:
          items:
            $ref: '#/components/schemas/WebhookStandardSchema'
          type: array
        limit:
          type: integer
          default: 10
        offset:
          type: integer
          default: 0
        next:
          type: string
      type: object
      required:
      - next
      - webhooks
      title: WebhooksList
    WebhookPatchRequest:
      properties:
        patch:
          items:
            $ref: '#/components/schemas/WebhookPatchData'
          type: array
      type: object
      required:
      - patch
      title: WebhookPatchRequest
      description: Update mode/origins/is_secure of webhook
      examples:
      - patch:
        - op: replace
          path: mode
          value: replace
      - patch:
        - op: replace
          path: is_secure
          value: false
      - patch:
        - op: replace
          path: origins
          value: '*'
  securitySchemes:
    bearerAuth:
      type: http
      description: 'Primary credential. Authorization: Bearer mm_<token>. The token is issued server-side and shown once at creation.'
      scheme: bearer
    apiKey:
      type: apiKey
      description: Deprecated — use bearerAuth.
      name: X-API-KEY
      in: header
    apiSecret:
      type: apiKey
      description: Deprecated — use bearerAuth.
      name: X-API-SECRET
      in: header
    workspaceId:
      type: apiKey
      description: Required with X-API-KEY and X-API-SECRET. Deprecated with them — use bearerAuth.
      name: X-WORKSPACE-ID
      in: header
x-refined-from:
- app.mammoth.io-openapi.json
- mammoth-io-openapi.json