Unified.to API — webhook

naftiko: 1.0.0-alpha2
info:
  label: Unified.to  API — webhook
  description: 'Unified.to  API — webhook. 8 operations. Lead operation: Returns all registered webhooks. Self-contained Naftiko
    capability covering one Unified To business surface.'
  tags:
  - Unified To
  - webhook
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    UNIFIED_TO_API_KEY: UNIFIED_TO_API_KEY
capability:
  consumes:
  - type: http
    namespace: unified-core-webhook
    baseUri: https://api.unified.to
    description: Unified.to  API — webhook business capability. Self-contained, no shared references.
    resources:
    - name: unified-webhook
      path: /unified/webhook
      operations:
      - name: listunifiedwebhooks
        method: GET
        description: Returns all registered webhooks
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: limit
          in: query
          type: number
        - name: offset
          in: query
          type: number
        - name: updated_gte
          in: query
          type: string
          description: Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ
            format)
        - name: sort
          in: query
          type: string
        - name: order
          in: query
          type: string
        - name: object
          in: query
          type: string
          description: Filter the results for webhooks for only this object
        - name: integration_type
          in: query
          type: string
          description: Filter the results to just this integration
        - name: connection_id
          in: query
          type: string
          description: Filter the results to just this integration
        - name: created_lte
          in: query
          type: string
          description: Return only results whose created date is equal or less to this value
        - name: env
          in: query
          type: string
      - name: createunifiedwebhook
        method: POST
        description: Create webhook subscription
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: include_all
          in: query
          type: boolean
          description: When set, all of the existing data will sent back to your server.
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: unified-webhook-id
      path: /unified/webhook/{id}
      operations:
      - name: removeunifiedwebhook
        method: DELETE
        description: Remove webhook subscription
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: ID of the Webhook
          required: true
      - name: getunifiedwebhook
        method: GET
        description: Retrieve webhook by its ID
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: ID of the Webhook
          required: true
      - name: patchunifiedwebhook
        method: PATCH
        description: Update webhook subscription
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: ID of the Webhook
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: updateunifiedwebhook
        method: PUT
        description: Update webhook subscription
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: ID of the Webhook
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: unified-webhook-id-trigger
      path: /unified/webhook/{id}/trigger
      operations:
      - name: patchunifiedwebhooktrigger
        method: PATCH
        description: Trigger webhook
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: ID of the Webhook
          required: true
      - name: updateunifiedwebhooktrigger
        method: PUT
        description: Trigger webhook
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: ID of the Webhook
          required: true
    authentication:
      type: apikey
      key: authorization
      value: '{{env.UNIFIED_TO_API_KEY}}'
      placement: header
  exposes:
  - type: rest
    namespace: unified-core-webhook-rest
    port: 8080
    description: REST adapter for Unified.to  API — webhook. One Spectral-compliant resource per consumed operation, prefixed
      with /v1.
    resources:
    - path: /v1/unified/webhook
      name: unified-webhook
      description: REST surface for unified-webhook.
      operations:
      - method: GET
        name: listunifiedwebhooks
        description: Returns all registered webhooks
        call: unified-core-webhook.listunifiedwebhooks
        with:
          limit: rest.limit
          offset: rest.offset
          updated_gte: rest.updated_gte
          sort: rest.sort
          order: rest.order
          object: rest.object
          integration_type: rest.integration_type
          connection_id: rest.connection_id
          created_lte: rest.created_lte
          env: rest.env
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createunifiedwebhook
        description: Create webhook subscription
        call: unified-core-webhook.createunifiedwebhook
        with:
          include_all: rest.include_all
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/unified/webhook/{id}
      name: unified-webhook-id
      description: REST surface for unified-webhook-id.
      operations:
      - method: DELETE
        name: removeunifiedwebhook
        description: Remove webhook subscription
        call: unified-core-webhook.removeunifiedwebhook
        with:
          id: rest.id
        outputParameters:
        - type: object
          mapping: $.
      - method: GET
        name: getunifiedwebhook
        description: Retrieve webhook by its ID
        call: unified-core-webhook.getunifiedwebhook
        with:
          id: rest.id
        outputParameters:
        - type: object
          mapping: $.
      - method: PATCH
        name: patchunifiedwebhook
        description: Update webhook subscription
        call: unified-core-webhook.patchunifiedwebhook
        with:
          id: rest.id
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: updateunifiedwebhook
        description: Update webhook subscription
        call: unified-core-webhook.updateunifiedwebhook
        with:
          id: rest.id
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/unified/webhook/{id}/trigger
      name: unified-webhook-id-trigger
      description: REST surface for unified-webhook-id-trigger.
      operations:
      - method: PATCH
        name: patchunifiedwebhooktrigger
        description: Trigger webhook
        call: unified-core-webhook.patchunifiedwebhooktrigger
        with:
          id: rest.id
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: updateunifiedwebhooktrigger
        description: Trigger webhook
        call: unified-core-webhook.updateunifiedwebhooktrigger
        with:
          id: rest.id
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: unified-core-webhook-mcp
    port: 9090
    transport: http
    description: MCP adapter for Unified.to  API — webhook. One tool per consumed operation, routed inline through this capability's
      consumes block.
    tools:
    - name: returns-all-registered-webhooks
      description: Returns all registered webhooks
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: unified-core-webhook.listunifiedwebhooks
      with:
        limit: tools.limit
        offset: tools.offset
        updated_gte: tools.updated_gte
        sort: tools.sort
        order: tools.order
        object: tools.object
        integration_type: tools.integration_type
        connection_id: tools.connection_id
        created_lte: tools.created_lte
        env: tools.env
      outputParameters:
      - type: object
        mapping: $.
    - name: create-webhook-subscription
      description: Create webhook subscription
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: unified-core-webhook.createunifiedwebhook
      with:
        include_all: tools.include_all
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: remove-webhook-subscription
      description: Remove webhook subscription
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: unified-core-webhook.removeunifiedwebhook
      with:
        id: tools.id
      outputParameters:
      - type: object
        mapping: $.
    - name: retrieve-webhook-its-id
      description: Retrieve webhook by its ID
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: unified-core-webhook.getunifiedwebhook
      with:
        id: tools.id
      outputParameters:
      - type: object
        mapping: $.
    - name: update-webhook-subscription
      description: Update webhook subscription
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: unified-core-webhook.patchunifiedwebhook
      with:
        id: tools.id
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: update-webhook-subscription-2
      description: Update webhook subscription
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: unified-core-webhook.updateunifiedwebhook
      with:
        id: tools.id
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: trigger-webhook
      description: Trigger webhook
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: unified-core-webhook.patchunifiedwebhooktrigger
      with:
        id: tools.id
      outputParameters:
      - type: object
        mapping: $.
    - name: trigger-webhook-2
      description: Trigger webhook
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: unified-core-webhook.updateunifiedwebhooktrigger
      with:
        id: tools.id
      outputParameters:
      - type: object
        mapping: $.