Convoy · Capability

Convoy API — EventTypes

Convoy webhooks gateway — EventTypes. 5 operations. Lead operation: Retrieves a project's event types. Self-contained Naftiko capability covering one Convoy business surface.

Run with Naftiko ConvoyWebhooksEventTypes

What You Can Do

GET
Geteventtypes — Retrieves a project's event types
/v1/projects/{project-id}/event-types
POST
Createeventtype — Create an event type
/v1/projects/{project-id}/event-types
POST
Importopenapispec — Import event types from OpenAPI spec
/v1/projects/{project-id}/event-types/import
PUT
Updateeventtype — Updates an event type
/v1/projects/{project-id}/event-types/{event-type-id}
POST
Deprecateeventtype — Deprecates an event type
/v1/projects/{project-id}/event-types/{event-type-id}/deprecate

MCP Tools

retrieves-project-s-event-types

Retrieves a project's event types

read-only idempotent
create-event-type

Create an event type

import-event-types-open-ap

Import event types from OpenAPI spec

updates-event-type

Updates an event type

idempotent
deprecates-event-type

Deprecates an event type

Capability Spec

convoy-event-types.yaml Raw ↑ 
naftiko: 1.0.0-alpha2
info:
  label: "Convoy API \u2014 EventTypes"
  description: "Convoy webhooks gateway \u2014 EventTypes. 5 operations. Lead operation: Retrieves a project's event types.\
    \ Self-contained Naftiko capability covering one Convoy business surface."
  tags:
  - Convoy
  - Webhooks
  - EventTypes
  created: '2026-05-22'
  modified: '2026-05-22'
binds:
- namespace: env
  keys:
    CONVOY_API_KEY: CONVOY_API_KEY
capability:
  consumes:
  - type: http
    namespace: convoy-event-types
    baseUri: https://us.getconvoy.cloud/api
    description: "Convoy API \u2014 EventTypes business capability. Self-contained, no shared references."
    authentication:
      type: bearer
      token: '{{env.CONVOY_API_KEY}}'
    resources:
    - name: v1-projects-project-id-event-types
      path: /v1/projects/{projectID}/event-types
      operations:
      - name: GetEventTypes
        method: GET
        description: Retrieves a project's event types
        inputParameters:
        - name: projectID
          in: path
          type: string
          required: true
          description: Project ID
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: CreateEventType
        method: POST
        description: Create an event type
        inputParameters:
        - name: projectID
          in: path
          type: string
          required: true
          description: Project ID
        - name: body
          in: body
          type: object
          required: true
          description: Request body payload.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: v1-projects-project-id-event-types-import
      path: /v1/projects/{projectID}/event-types/import
      operations:
      - name: ImportOpenApiSpec
        method: POST
        description: Import event types from OpenAPI spec
        inputParameters:
        - name: projectID
          in: path
          type: string
          required: true
          description: Project ID
        - name: body
          in: body
          type: object
          required: true
          description: Request body payload.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: v1-projects-project-id-event-types-event-type-id
      path: /v1/projects/{projectID}/event-types/{eventTypeId}
      operations:
      - name: UpdateEventType
        method: PUT
        description: Updates an event type
        inputParameters:
        - name: projectID
          in: path
          type: string
          required: true
          description: Project ID
        - name: body
          in: body
          type: object
          required: true
          description: Request body payload.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: v1-projects-project-id-event-types-event-type-id-deprecate
      path: /v1/projects/{projectID}/event-types/{eventTypeId}/deprecate
      operations:
      - name: DeprecateEventType
        method: POST
        description: Deprecates an event type
        inputParameters:
        - name: projectID
          in: path
          type: string
          required: true
          description: Project ID
        - name: eventTypeId
          in: path
          type: string
          required: true
          description: Event Type ID
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
  exposes:
  - type: rest
    namespace: convoy-event-types-rest
    port: 8080
    description: "REST adapter for Convoy API \u2014 EventTypes. One Spectral-compliant resource per consumed operation, prefixed\
      \ with /v1."
    resources:
    - path: /v1/projects/{project-id}/event-types
      name: v1-projects-project-id-event-types
      description: REST surface for /v1/projects/{project-id}/event-types.
      operations:
      - method: GET
        name: GetEventTypes
        description: Retrieves a project's event types
        call: convoy-event-types.GetEventTypes
        with:
          projectID: rest.projectID
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: CreateEventType
        description: Create an event type
        call: convoy-event-types.CreateEventType
        with:
          projectID: rest.projectID
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/projects/{project-id}/event-types/import
      name: v1-projects-project-id-event-types-import
      description: REST surface for /v1/projects/{project-id}/event-types/import.
      operations:
      - method: POST
        name: ImportOpenApiSpec
        description: Import event types from OpenAPI spec
        call: convoy-event-types.ImportOpenApiSpec
        with:
          projectID: rest.projectID
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/projects/{project-id}/event-types/{event-type-id}
      name: v1-projects-project-id-event-types-event-type-id
      description: REST surface for /v1/projects/{project-id}/event-types/{event-type-id}.
      operations:
      - method: PUT
        name: UpdateEventType
        description: Updates an event type
        call: convoy-event-types.UpdateEventType
        with:
          projectID: rest.projectID
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/projects/{project-id}/event-types/{event-type-id}/deprecate
      name: v1-projects-project-id-event-types-event-type-id-deprecate
      description: REST surface for /v1/projects/{project-id}/event-types/{event-type-id}/deprecate.
      operations:
      - method: POST
        name: DeprecateEventType
        description: Deprecates an event type
        call: convoy-event-types.DeprecateEventType
        with:
          projectID: rest.projectID
          eventTypeId: rest.eventTypeId
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: convoy-event-types-mcp
    port: 9090
    transport: http
    description: "MCP adapter for Convoy API \u2014 EventTypes. One tool per consumed operation, routed inline through this\
      \ capability's consumes block."
    tools:
    - name: retrieves-project-s-event-types
      description: Retrieves a project's event types
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: convoy-event-types.GetEventTypes
      with:
        projectID: tools.projectID
      outputParameters:
      - type: object
        mapping: $.
    - name: create-event-type
      description: Create an event type
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: convoy-event-types.CreateEventType
      with:
        projectID: tools.projectID
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: import-event-types-open-ap
      description: Import event types from OpenAPI spec
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: convoy-event-types.ImportOpenApiSpec
      with:
        projectID: tools.projectID
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: updates-event-type
      description: Updates an event type
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: convoy-event-types.UpdateEventType
      with:
        projectID: tools.projectID
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: deprecates-event-type
      description: Deprecates an event type
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: convoy-event-types.DeprecateEventType
      with:
        projectID: tools.projectID
        eventTypeId: tools.eventTypeId
      outputParameters:
      - type: object
        mapping: $.