naftiko: 1.0.0-alpha2
info:
  label: FusionAuth API — Webhook
  description: 'FusionAuth API — Webhook. 8 operations. Lead operation: Retrieves the webhook for the given Id. If you pass in null for the Id, this will return all the webhooks.. Self-contained Naftiko capability covering one business surface.'
  tags:
  - FusionAuth
  - Webhook
  created: '2026-05-20'
  modified: '2026-05-20'
binds:
- namespace: env
  keys:
    FUSIONAUTH_API_KEY: FUSIONAUTH_API_KEY
capability:
  consumes:
  - type: http
    namespace: fusionauth-webhook
    baseUri: http://localhost:9011
    description: FusionAuth API — Webhook business capability. Self-contained, no shared references.
    resources:
    - name: api-webhook
      path: /api/webhook
      operations:
      - name: createwebhook
        method: POST
        description: Creates a webhook. You can optionally specify an Id for the webhook, if not provided one will be generated.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
      - name: retrievewebhook
        method: GET
        description: Retrieves the webhook for the given Id. If you pass in null for the Id, this will return all the webhooks.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters: []
    - name: api-webhook-search
      path: /api/webhook/search
      operations:
      - name: searchwebhookswithid
        method: POST
        description: Searches webhooks with the specified criteria and pagination.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: api-webhook-webhookid
      path: /api/webhook/{webhookId}
      operations:
      - name: createwebhookwithid
        method: POST
        description: Creates a webhook. You can optionally specify an Id for the webhook, if not provided one will be generated.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: webhookId
          in: path
          type: string
          description: The Id for the webhook. If not provided a secure random UUID will be generated.
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
      - name: deletewebhookwithid
        method: DELETE
        description: Deletes the webhook for the given Id.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: webhookId
          in: path
          type: string
          description: The Id of the webhook to delete.
          required: true
      - name: patchwebhookwithid
        method: PATCH
        description: Patches the webhook with the given Id.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: webhookId
          in: path
          type: string
          description: The Id of the webhook to update.
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
      - name: retrievewebhookwithid
        method: GET
        description: Retrieves the webhook for the given Id. If you pass in null for the Id, this will return all the webhooks.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: webhookId
          in: path
          type: string
          description: The Id of the webhook.
          required: true
      - name: updatewebhookwithid
        method: PUT
        description: Updates the webhook with the given Id.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: webhookId
          in: path
          type: string
          description: The Id of the webhook to update.
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
  exposes:
  - type: rest
    namespace: fusionauth-webhook-rest
    port: 8080
    description: REST adapter for FusionAuth API — Webhook. One resource per consumed operation, prefixed with /v1.
    resources:
    - path: /v1/api/webhook
      name: api-webhook
      description: REST surface for api-webhook.
      operations:
      - method: POST
        name: createwebhook
        description: Creates a webhook. You can optionally specify an Id for the webhook, if not provided one will be generated.
        call: fusionauth-webhook.createwebhook
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: GET
        name: retrievewebhook
        description: Retrieves the webhook for the given Id. If you pass in null for the Id, this will return all the webhooks.
        call: fusionauth-webhook.retrievewebhook
        with: {}
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/webhook/search
      name: api-webhook-search
      description: REST surface for api-webhook-search.
      operations:
      - method: POST
        name: searchwebhookswithid
        description: Searches webhooks with the specified criteria and pagination.
        call: fusionauth-webhook.searchwebhookswithid
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/webhook/{webhookId}
      name: api-webhook-webhookid
      description: REST surface for api-webhook-webhookid.
      operations:
      - method: POST
        name: createwebhookwithid
        description: Creates a webhook. You can optionally specify an Id for the webhook, if not provided one will be generated.
        call: fusionauth-webhook.createwebhookwithid
        with:
          webhookId: rest.webhookId
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deletewebhookwithid
        description: Deletes the webhook for the given Id.
        call: fusionauth-webhook.deletewebhookwithid
        with:
          webhookId: rest.webhookId
        outputParameters:
        - type: object
          mapping: $.
      - method: PATCH
        name: patchwebhookwithid
        description: Patches the webhook with the given Id.
        call: fusionauth-webhook.patchwebhookwithid
        with:
          webhookId: rest.webhookId
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: GET
        name: retrievewebhookwithid
        description: Retrieves the webhook for the given Id. If you pass in null for the Id, this will return all the webhooks.
        call: fusionauth-webhook.retrievewebhookwithid
        with:
          webhookId: rest.webhookId
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: updatewebhookwithid
        description: Updates the webhook with the given Id.
        call: fusionauth-webhook.updatewebhookwithid
        with:
          webhookId: rest.webhookId
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: fusionauth-webhook-mcp
    port: 9090
    transport: http
    description: MCP adapter for FusionAuth API — Webhook. One tool per consumed operation, routed inline through this capability's consumes block.
    tools:
    - name: fusionauth-createwebhook
      description: Creates a webhook. You can optionally specify an Id for the webhook, if not provided one will be generated.
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: fusionauth-webhook.createwebhook
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: fusionauth-retrievewebhook
      description: Retrieves the webhook for the given Id. If you pass in null for the Id, this will return all the webhooks.
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: fusionauth-webhook.retrievewebhook
      with: {}
      outputParameters:
      - type: object
        mapping: $.
    - name: fusionauth-searchwebhookswithid
      description: Searches webhooks with the specified criteria and pagination.
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: fusionauth-webhook.searchwebhookswithid
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: fusionauth-createwebhookwithid
      description: Creates a webhook. You can optionally specify an Id for the webhook, if not provided one will be generated.
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: fusionauth-webhook.createwebhookwithid
      with:
        webhookId: tools.webhookId
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: fusionauth-deletewebhookwithid
      description: Deletes the webhook for the given Id.
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: fusionauth-webhook.deletewebhookwithid
      with:
        webhookId: tools.webhookId
      outputParameters:
      - type: object
        mapping: $.
    - name: fusionauth-patchwebhookwithid
      description: Patches the webhook with the given Id.
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: fusionauth-webhook.patchwebhookwithid
      with:
        webhookId: tools.webhookId
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: fusionauth-retrievewebhookwithid
      description: Retrieves the webhook for the given Id. If you pass in null for the Id, this will return all the webhooks.
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: fusionauth-webhook.retrievewebhookwithid
      with:
        webhookId: tools.webhookId
      outputParameters:
      - type: object
        mapping: $.
    - name: fusionauth-updatewebhookwithid
      description: Updates the webhook with the given Id.
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: fusionauth-webhook.updatewebhookwithid
      with:
        webhookId: tools.webhookId
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.