Dokploy API — notification

naftiko: 1.0.0-alpha2
info:
  label: Dokploy API — notification
  description: 'Dokploy API — notification. 41 operations. Lead operation: notification.createSlack. Self-contained Naftiko capability covering
    one Dokploy business surface.'
  tags:
  - Dokploy
  - notification
  created: '2026-05-25'
  modified: '2026-05-25'
binds:
- namespace: env
  keys:
    DOKPLOY_API_KEY: DOKPLOY_API_KEY
    DOKPLOY_URL: DOKPLOY_URL
capability:
  consumes:
  - type: http
    namespace: dokploy-notification
    baseUri: ${DOKPLOY_URL}/api
    description: Dokploy API — notification business capability. Self-contained, no shared references.
    resources:
    - name: createSlack
      path: /notification.createSlack
      operations:
      - name: notification-createSlack
        method: POST
        description: notification-createSlack
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body
          required: true
    - name: updateSlack
      path: /notification.updateSlack
      operations:
      - name: notification-updateSlack
        method: POST
        description: notification-updateSlack
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body
          required: true
    - name: testSlackConnection
      path: /notification.testSlackConnection
      operations:
      - name: notification-testSlackConnection
        method: POST
        description: notification-testSlackConnection
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body
          required: true
    - name: createTelegram
      path: /notification.createTelegram
      operations:
      - name: notification-createTelegram
        method: POST
        description: notification-createTelegram
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body
          required: true
    - name: updateTelegram
      path: /notification.updateTelegram
      operations:
      - name: notification-updateTelegram
        method: POST
        description: notification-updateTelegram
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body
          required: true
    - name: testTelegramConnection
      path: /notification.testTelegramConnection
      operations:
      - name: notification-testTelegramConnection
        method: POST
        description: notification-testTelegramConnection
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body
          required: true
    - name: createDiscord
      path: /notification.createDiscord
      operations:
      - name: notification-createDiscord
        method: POST
        description: notification-createDiscord
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body
          required: true
    - name: updateDiscord
      path: /notification.updateDiscord
      operations:
      - name: notification-updateDiscord
        method: POST
        description: notification-updateDiscord
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body
          required: true
    - name: testDiscordConnection
      path: /notification.testDiscordConnection
      operations:
      - name: notification-testDiscordConnection
        method: POST
        description: notification-testDiscordConnection
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body
          required: true
    - name: createEmail
      path: /notification.createEmail
      operations:
      - name: notification-createEmail
        method: POST
        description: notification-createEmail
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body
          required: true
    - name: updateEmail
      path: /notification.updateEmail
      operations:
      - name: notification-updateEmail
        method: POST
        description: notification-updateEmail
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body
          required: true
    - name: testEmailConnection
      path: /notification.testEmailConnection
      operations:
      - name: notification-testEmailConnection
        method: POST
        description: notification-testEmailConnection
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body
          required: true
    - name: createResend
      path: /notification.createResend
      operations:
      - name: notification-createResend
        method: POST
        description: notification-createResend
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body
          required: true
    - name: updateResend
      path: /notification.updateResend
      operations:
      - name: notification-updateResend
        method: POST
        description: notification-updateResend
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body
          required: true
    - name: testResendConnection
      path: /notification.testResendConnection
      operations:
      - name: notification-testResendConnection
        method: POST
        description: notification-testResendConnection
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body
          required: true
    - name: remove
      path: /notification.remove
      operations:
      - name: notification-remove
        method: POST
        description: notification-remove
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body
          required: true
    - name: one
      path: /notification.one
      operations:
      - name: notification-one
        method: GET
        description: notification-one
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: all
      path: /notification.all
      operations:
      - name: notification-all
        method: GET
        description: notification-all
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: receiveNotification
      path: /notification.receiveNotification
      operations:
      - name: notification-receiveNotification
        method: POST
        description: notification-receiveNotification
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body
          required: true
    - name: createGotify
      path: /notification.createGotify
      operations:
      - name: notification-createGotify
        method: POST
        description: notification-createGotify
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body
          required: true
    - name: updateGotify
      path: /notification.updateGotify
      operations:
      - name: notification-updateGotify
        method: POST
        description: notification-updateGotify
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body
          required: true
    - name: testGotifyConnection
      path: /notification.testGotifyConnection
      operations:
      - name: notification-testGotifyConnection
        method: POST
        description: notification-testGotifyConnection
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body
          required: true
    - name: createNtfy
      path: /notification.createNtfy
      operations:
      - name: notification-createNtfy
        method: POST
        description: notification-createNtfy
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body
          required: true
    - name: updateNtfy
      path: /notification.updateNtfy
      operations:
      - name: notification-updateNtfy
        method: POST
        description: notification-updateNtfy
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body
          required: true
    - name: testNtfyConnection
      path: /notification.testNtfyConnection
      operations:
      - name: notification-testNtfyConnection
        method: POST
        description: notification-testNtfyConnection
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body
          required: true
    - name: createMattermost
      path: /notification.createMattermost
      operations:
      - name: notification-createMattermost
        method: POST
        description: notification-createMattermost
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body
          required: true
    - name: updateMattermost
      path: /notification.updateMattermost
      operations:
      - name: notification-updateMattermost
        method: POST
        description: notification-updateMattermost
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body
          required: true
    - name: testMattermostConnection
      path: /notification.testMattermostConnection
      operations:
      - name: notification-testMattermostConnection
        method: POST
        description: notification-testMattermostConnection
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body
          required: true
    - name: createCustom
      path: /notification.createCustom
      operations:
      - name: notification-createCustom
        method: POST
        description: notification-createCustom
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body
          required: true
    - name: updateCustom
      path: /notification.updateCustom
      operations:
      - name: notification-updateCustom
        method: POST
        description: notification-updateCustom
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body
          required: true
    - name: testCustomConnection
      path: /notification.testCustomConnection
      operations:
      - name: notification-testCustomConnection
        method: POST
        description: notification-testCustomConnection
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body
          required: true
    - name: createLark
      path: /notification.createLark
      operations:
      - name: notification-createLark
        method: POST
        description: notification-createLark
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body
          required: true
    - name: updateLark
      path: /notification.updateLark
      operations:
      - name: notification-updateLark
        method: POST
        description: notification-updateLark
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body
          required: true
    - name: testLarkConnection
      path: /notification.testLarkConnection
      operations:
      - name: notification-testLarkConnection
        method: POST
        description: notification-testLarkConnection
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body
          required: true
    - name: createTeams
      path: /notification.createTeams
      operations:
      - name: notification-createTeams
        method: POST
        description: notification-createTeams
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body
          required: true
    - name: updateTeams
      path: /notification.updateTeams
      operations:
      - name: notification-updateTeams
        method: POST
        description: notification-updateTeams
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body
          required: true
    - name: testTeamsConnection
      path: /notification.testTeamsConnection
      operations:
      - name: notification-testTeamsConnection
        method: POST
        description: notification-testTeamsConnection
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body
          required: true
    - name: createPushover
      path: /notification.createPushover
      operations:
      - name: notification-createPushover
        method: POST
        description: notification-createPushover
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body
          required: true
    - name: updatePushover
      path: /notification.updatePushover
      operations:
      - name: notification-updatePushover
        method: POST
        description: notification-updatePushover
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body
          required: true
    - name: testPushoverConnection
      path: /notification.testPushoverConnection
      operations:
      - name: notification-testPushoverConnection
        method: POST
        description: notification-testPushoverConnection
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body
          required: true
    - name: getEmailProviders
      path: /notification.getEmailProviders
      operations:
      - name: notification-getEmailProviders
        method: GET
        description: notification-getEmailProviders
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
  exposes:
  - type: rest
    namespace: dokploy-notification-rest
    port: 8080
    description: REST adapter for Dokploy API — notification. One Spectral-compliant resource per consumed operation, prefixed with /v1.
    resources:
    - path: /v1/notification.createSlack
      name: createSlack
      description: REST surface for createSlack.
      operations:
      - method: POST
        name: notification-createSlack
        description: notification-createSlack
        call: dokploy-notification.notification-createSlack
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/notification.updateSlack
      name: updateSlack
      description: REST surface for updateSlack.
      operations:
      - method: POST
        name: notification-updateSlack
        description: notification-updateSlack
        call: dokploy-notification.notification-updateSlack
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/notification.testSlackConnection
      name: testSlackConnection
      description: REST surface for testSlackConnection.
      operations:
      - method: POST
        name: notification-testSlackConnection
        description: notification-testSlackConnection
        call: dokploy-notification.notification-testSlackConnection
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/notification.createTelegram
      name: createTelegram
      description: REST surface for createTelegram.
      operations:
      - method: POST
        name: notification-createTelegram
        description: notification-createTelegram
        call: dokploy-notification.notification-createTelegram
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/notification.updateTelegram
      name: updateTelegram
      description: REST surface for updateTelegram.
      operations:
      - method: POST
        name: notification-updateTelegram
        description: notification-updateTelegram
        call: dokploy-notification.notification-updateTelegram
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/notification.testTelegramConnection
      name: testTelegramConnection
      description: REST surface for testTelegramConnection.
      operations:
      - method: POST
        name: notification-testTelegramConnection
        description: notification-testTelegramConnection
        call: dokploy-notification.notification-testTelegramConnection
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/notification.createDiscord
      name: createDiscord
      description: REST surface for createDiscord.
      operations:
      - method: POST
        name: notification-createDiscord
        description: notification-createDiscord
        call: dokploy-notification.notification-createDiscord
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/notification.updateDiscord
      name: updateDiscord
      description: REST surface for updateDiscord.
      operations:
      - method: POST
        name: notification-updateDiscord
        description: notification-updateDiscord
        call: dokploy-notification.notification-updateDiscord
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/notification.testDiscordConnection
      name: testDiscordConnection
      description: REST surface for testDiscordConnection.
      operations:
      - method: POST
        name: notification-testDiscordConnection
        description: notification-testDiscordConnection
        call: dokploy-notification.notification-testDiscordConnection
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/notification.createEmail
      name: createEmail
      description: REST surface for createEmail.
      operations:
      - method: POST
        name: notification-createEmail
        description: notification-createEmail
        call: dokploy-notification.notification-createEmail
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/notification.updateEmail
      name: updateEmail
      description: REST surface for updateEmail.
      operations:
      - method: POST
        name: notification-updateEmail
        description: notification-updateEmail
        call: dokploy-notification.notification-updateEmail
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/notification.testEmailConnection
      name: testEmailConnection
      description: REST surface for testEmailConnection.
      operations:
      - method: POST
        name: notification-testEmailConnection
        description: notification-testEmailConnection
        call: dokploy-notification.notification-testEmailConnection
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/notification.createResend
      name: createResend
      description: REST surface for createResend.
      operations:
      - method: POST
        name: notification-createResend
        description: notification-createResend
        call: dokploy-notification.notification-createResend
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/notification.updateResend
      name: updateResend
      description: REST surface for updateResend.
      operations:
      - method: POST
        name: notification-updateResend
        description: notification-updateResend
        call: dokploy-notification.notification-updateResend
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/notification.testResendConnection
      name: testResendConnection
      description: REST surface for testResendConnection.
      operations:
      - method: POST
        name: notification-testResendConnection
        description: notification-testResendConnection
        call: dokploy-notification.notification-testResendConnection
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/notification.remove
      name: remove
      description: REST surface for remove.
      operations:
      - method: POST
        name: notification-remove
        description: notification-remove
        call: dokploy-notification.notification-remove
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/notification.one
      name: one
      description: REST surface for one.
      operations:
      - method: GET
        name: notification-one
        description: notification-one
        call: dokploy-notification.notification-one
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/notification.all
      name: all
      description: REST surface for all.
      operations:
      - method: GET
        name: notification-all
        description: notification-all
        call: dokploy-notification.notification-all
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/notification.receiveNotification
      name: receiveNotification
      description: REST surface for receiveNotification.
      operations:
      - method: POST
        name: notification-receiveNotification
        description: notification-receiveNotification
        call: dokploy-notification.notification-receiveNotification
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/notification.createGotify
      name: createGotify
      description: REST surface for createGotify.
      operations:
      - method: POST
        name: notification-createGotify
        description: notification-createGotify
        call: dokploy-notification.notification-createGotify
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/notification.updateGotify
      name: updateGotify
      description: REST surface for updateGotify.
      operations:
      - method: POST
        name: notification-updateGotify
        description: notification-updateGotify
        call: dokploy-notification.notification-updateGotify
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/notification.testGotifyConnection
      name: testGotifyConnection
      description: REST surface for testGotifyConnection.
      operations:
      - method: POST
        name: notification-testGotifyConnection
        description: notification-testGotifyConnection
        call: dokploy-notification.notification-testGotifyConnection
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/notification.createNtfy
      name: createNtfy
      description: REST surface for createNtfy.
      operations:
      - method: POST
        name: notification-createNtfy
        description: notification-createNtfy
        call: dokploy-notification.notification-createNtfy
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/notification.updateNtfy
      name: updateNtfy
      description: REST surface for updateNtfy.
      operations:
      - method: POST
        name: notification-updateNtfy
        description: notification-updateNtfy
        call: dokploy-notification.notification-updateNtfy
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/notification.testNtfyConnection
      name: testNtfyConnection
      description: REST surface for testNtfyConnection.
      operations:
      - method: POST
        name: notification-testNtfyConnection
        description: notification-testNtfyConnection
        call: dokploy-notification.notification-testNtfyConnection
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/notification.createMattermost
      name: createMattermost
      description: REST surface for createMattermost.
      operations:
      - method: POST
        name: notification-createMattermost
        description: notification-createMattermost
        call: dokploy-notification.notification-createMattermost
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/notification.updateMattermost
      name: updateMattermost
      description: REST surface for updateMattermost.
      operations:
      - method: POST
        name: notification-updateMattermost
        description: notification-updateMattermost
        call: dokploy-notification.notification-updateMattermost
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/notification.testMattermostConnection
      name: testMattermostConnection
      description: REST surface for testMattermostConnection.
      operations:
      - method: POST
        name: notification-testMattermostConnection
        description: notification-testMattermostConnection
        call: dokploy-notification.notification-testMattermostConnection
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/notification.createCustom
      name: createCustom
      description: REST surface for createCustom.
      operations:
      - method: POST
        name: notification-createCustom
        description: notification-createCustom
        call: dokploy-notification.notification-createCustom
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/notification.updateCustom
      name: updateCustom
      description: REST surface for updateCustom.
      operations:
      - method: POST
        name: notification-updateCustom
        description: notification-updateCustom
        call: dokploy-notification.notification-updateCustom
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/notification.testCustomConnection
      name: testCustomConnection
      description: REST surface for testCustomConnection.
      operations:
      - method: POST
        name: notification-testCustomConnection
        description: notification-testCustomConnection
        call: dokploy-notification.notification-testCustomConnection
       

# --- truncated at 32 KB (50 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/dokploy/refs/heads/main/capabilities/dokploy-notification.yaml