API Reference — Notifications

naftiko: 1.0.0-alpha2
info:
  label: API Reference — Notifications
  description: 'API Reference — Notifications. 17 operations. Lead operation: Resend callout notifications. Self-contained
    Naftiko capability covering one Zuora business surface.'
  tags:
  - Zuora
  - Notifications
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    ZUORA_API_KEY: ZUORA_API_KEY
capability:
  consumes:
  - type: http
    namespace: v1-notifications
    baseUri: https://rest.zuora.com
    description: API Reference — Notifications business capability. Self-contained, no shared references.
    resources:
    - name: notifications-callout-histories-resend
      path: /notifications/callout-histories/resend
      operations:
      - name: postresendcalloutnotifications
        method: POST
        description: Resend callout notifications
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: POSTResendCalloutNotifications
          in: body
          type: string
          description: The request body to resend callout notifications.
          required: true
    - name: notifications-email-histories-resend
      path: /notifications/email-histories/resend
      operations:
      - name: postresendemailnotifications
        method: POST
        description: Resend email notifications
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: POSTResendEmailNotifications
          in: body
          type: string
          description: The request body to resend email notifications.
          required: true
    - name: notifications-email-templates
      path: /notifications/email-templates
      operations:
      - name: postcreateemailtemplate
        method: POST
        description: Create an email template
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: POSTPublicEmailTemplateRequest
          in: body
          type: string
          description: The request body to create an email template.
          required: true
      - name: getqueryemailtemplates
        method: GET
        description: List email templates
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: start
          in: query
          type: integer
          description: The first index of the query result.
        - name: limit
          in: query
          type: integer
          description: The maximum number of results the query should return.
        - name: eventCategory
          in: query
          type: number
          description: The event category code for standard events.
        - name: eventTypeName
          in: query
          type: string
          description: The name of the custom event or custom scheduled event.
        - name: name
          in: query
          type: string
          description: The name of the email template.
    - name: notifications-email-templates-import
      path: /notifications/email-templates/import
      operations:
      - name: postcreateorupdateemailtemplates
        method: POST
        description: Create or update email templates
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: POSTCreateOrUpdateEmailTemplateRequest
          in: body
          type: string
          description: The request body to import or update email templates.
          required: true
    - name: notifications-email-templates-id
      path: /notifications/email-templates/{id}
      operations:
      - name: putupdateemailtemplate
        method: PUT
        description: Update an email template
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: The ID of the email template to be updated.
          required: true
        - name: PUTPublicEmailTemplateRequest
          in: body
          type: string
          description: The request body to update an email template.
          required: true
      - name: getgetemailtemplate
        method: GET
        description: Retrieve an email template
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: The ID of the email template.
          required: true
      - name: deletedeleteemailtemplate
        method: DELETE
        description: Delete an email template
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: The ID of the email template to be deleted.
          required: true
    - name: notifications-history
      path: /notifications/history
      operations:
      - name: deletedeletenotificationhistoryforaccount
        method: DELETE
        description: Delete notification histories for an account
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: accountId
          in: query
          type: string
          description: The ID of the account whose notification histories are to be deleted.
          required: true
    - name: notifications-history-tasks-id
      path: /notifications/history/tasks/{id}
      operations:
      - name: getgetnotificationhistorydeletiontask
        method: GET
        description: Retrieve a notification history deletion task
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: The ID of the notification history deletion task. You can get the deletion task ID from the 202 response
            body of the [Delete notification histories for an accou
          required: true
    - name: notifications-notification-definitions
      path: /notifications/notification-definitions
      operations:
      - name: postcreatenotificationdefinition
        method: POST
        description: Create a notification definition
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: entity
          in: body
          type: string
          description: The request body used to create the notification definition.
          required: true
      - name: getquerynotificationdefinitions
        method: GET
        description: List notification definitions
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: start
          in: query
          type: integer
          description: The first index of the query result.
        - name: limit
          in: query
          type: integer
          description: The maximum number of results the query should return.
        - name: profileId
          in: query
          type: string
          description: Id of the profile.
        - name: eventTypeName
          in: query
          type: string
          description: The name of the event.
        - name: emailTemplateId
          in: query
          type: string
          description: The ID of the email template.
    - name: notifications-notification-definitions-id
      path: /notifications/notification-definitions/{id}
      operations:
      - name: putupdatenotificationdefinition
        method: PUT
        description: Update a notification definition
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: The ID of the notification definition to be updated.
          required: true
        - name: PUTPublicNotificationDefinitionRequest
          in: body
          type: string
          description: The request body of the notification definition to be updated.
          required: true
      - name: getgetnotificationdefinition
        method: GET
        description: Retrieve a notification definition
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: The ID of the notification definition.
          required: true
      - name: deletedeletenotificationdefinition
        method: DELETE
        description: Delete a notification definition
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: The ID of the notification definition to be deleted.
          required: true
    - name: v1-notification-history-callout
      path: /v1/notification-history/callout
      operations:
      - name: getcallouthistory
        method: GET
        description: List callout notification histories
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: endTime
          in: query
          type: string
          description: The final date and time of records to be returned. Defaults to now. Use format yyyy-MM-ddTHH:mm:ss.
        - name: startTime
          in: query
          type: string
          description: The initial date and time of records to be returned. Defaults to (end time - 1 day). Use format yyyy-MM-ddTHH:mm:ss.
        - name: objectId
          in: query
          type: string
          description: The ID of an object that triggered a callout notification.
        - name: failedOnly
          in: query
          type: boolean
          description: If `true`, only return failed records. If `false`, return all records in the given date range. The
            default value is `true`.
        - name: eventCategory
          in: query
          type: string
          description: Category of records to be returned by event category.
        - name: includeResponseContent
          in: query
          type: boolean
    - name: v1-notification-history-email
      path: /v1/notification-history/email
      operations:
      - name: getemailhistory
        method: GET
        description: List email notification histories
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: accountId
          in: query
          type: string
          description: ID of an account. By specifying this query parameter, you can filter email notification histories by
            account.
        - name: endTime
          in: query
          type: string
          description: The end date and time of records to be returned. Defaults to now. Use format yyyy-MM-ddTHH:mm:ss. The
            maximum date range (endTime - startTime) is three days.
        - name: startTime
          in: query
          type: string
          description: The initial date and time of records to be returned. Defaults to (end time - 1 day). Use format yyyy-MM-ddTHH:mm:ss.
            The maximum date range (endTime - startTime
        - name: objectId
          in: query
          type: string
          description: The Id of an object that triggered an email notification.
        - name: failedOnly
          in: query
          type: boolean
          description: If `true`, only returns failed records. When `false`, returns all records in the given date range.
            Defaults to `true` when not specified.
        - name: eventCategory
          in: query
          type: number
          description: Category of records to be returned by event category.
  exposes:
  - type: rest
    namespace: v1-notifications-rest
    port: 8080
    description: REST adapter for API Reference — Notifications. One Spectral-compliant resource per consumed operation, prefixed
      with /v1.
    resources:
    - path: /v1/notifications/callout-histories/resend
      name: notifications-callout-histories-resend
      description: REST surface for notifications-callout-histories-resend.
      operations:
      - method: POST
        name: postresendcalloutnotifications
        description: Resend callout notifications
        call: v1-notifications.postresendcalloutnotifications
        with:
          POSTResendCalloutNotifications: rest.POSTResendCalloutNotifications
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/notifications/email-histories/resend
      name: notifications-email-histories-resend
      description: REST surface for notifications-email-histories-resend.
      operations:
      - method: POST
        name: postresendemailnotifications
        description: Resend email notifications
        call: v1-notifications.postresendemailnotifications
        with:
          POSTResendEmailNotifications: rest.POSTResendEmailNotifications
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/notifications/email-templates
      name: notifications-email-templates
      description: REST surface for notifications-email-templates.
      operations:
      - method: POST
        name: postcreateemailtemplate
        description: Create an email template
        call: v1-notifications.postcreateemailtemplate
        with:
          POSTPublicEmailTemplateRequest: rest.POSTPublicEmailTemplateRequest
        outputParameters:
        - type: object
          mapping: $.
      - method: GET
        name: getqueryemailtemplates
        description: List email templates
        call: v1-notifications.getqueryemailtemplates
        with:
          start: rest.start
          limit: rest.limit
          eventCategory: rest.eventCategory
          eventTypeName: rest.eventTypeName
          name: rest.name
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/notifications/email-templates/import
      name: notifications-email-templates-import
      description: REST surface for notifications-email-templates-import.
      operations:
      - method: POST
        name: postcreateorupdateemailtemplates
        description: Create or update email templates
        call: v1-notifications.postcreateorupdateemailtemplates
        with:
          POSTCreateOrUpdateEmailTemplateRequest: rest.POSTCreateOrUpdateEmailTemplateRequest
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/notifications/email-templates/{id}
      name: notifications-email-templates-id
      description: REST surface for notifications-email-templates-id.
      operations:
      - method: PUT
        name: putupdateemailtemplate
        description: Update an email template
        call: v1-notifications.putupdateemailtemplate
        with:
          id: rest.id
          PUTPublicEmailTemplateRequest: rest.PUTPublicEmailTemplateRequest
        outputParameters:
        - type: object
          mapping: $.
      - method: GET
        name: getgetemailtemplate
        description: Retrieve an email template
        call: v1-notifications.getgetemailtemplate
        with:
          id: rest.id
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deletedeleteemailtemplate
        description: Delete an email template
        call: v1-notifications.deletedeleteemailtemplate
        with:
          id: rest.id
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/notifications/history
      name: notifications-history
      description: REST surface for notifications-history.
      operations:
      - method: DELETE
        name: deletedeletenotificationhistoryforaccount
        description: Delete notification histories for an account
        call: v1-notifications.deletedeletenotificationhistoryforaccount
        with:
          accountId: rest.accountId
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/notifications/history/tasks/{id}
      name: notifications-history-tasks-id
      description: REST surface for notifications-history-tasks-id.
      operations:
      - method: GET
        name: getgetnotificationhistorydeletiontask
        description: Retrieve a notification history deletion task
        call: v1-notifications.getgetnotificationhistorydeletiontask
        with:
          id: rest.id
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/notifications/notification-definitions
      name: notifications-notification-definitions
      description: REST surface for notifications-notification-definitions.
      operations:
      - method: POST
        name: postcreatenotificationdefinition
        description: Create a notification definition
        call: v1-notifications.postcreatenotificationdefinition
        with:
          entity: rest.entity
        outputParameters:
        - type: object
          mapping: $.
      - method: GET
        name: getquerynotificationdefinitions
        description: List notification definitions
        call: v1-notifications.getquerynotificationdefinitions
        with:
          start: rest.start
          limit: rest.limit
          profileId: rest.profileId
          eventTypeName: rest.eventTypeName
          emailTemplateId: rest.emailTemplateId
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/notifications/notification-definitions/{id}
      name: notifications-notification-definitions-id
      description: REST surface for notifications-notification-definitions-id.
      operations:
      - method: PUT
        name: putupdatenotificationdefinition
        description: Update a notification definition
        call: v1-notifications.putupdatenotificationdefinition
        with:
          id: rest.id
          PUTPublicNotificationDefinitionRequest: rest.PUTPublicNotificationDefinitionRequest
        outputParameters:
        - type: object
          mapping: $.
      - method: GET
        name: getgetnotificationdefinition
        description: Retrieve a notification definition
        call: v1-notifications.getgetnotificationdefinition
        with:
          id: rest.id
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deletedeletenotificationdefinition
        description: Delete a notification definition
        call: v1-notifications.deletedeletenotificationdefinition
        with:
          id: rest.id
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v1/notification-history/callout
      name: v1-notification-history-callout
      description: REST surface for v1-notification-history-callout.
      operations:
      - method: GET
        name: getcallouthistory
        description: List callout notification histories
        call: v1-notifications.getcallouthistory
        with:
          endTime: rest.endTime
          startTime: rest.startTime
          objectId: rest.objectId
          failedOnly: rest.failedOnly
          eventCategory: rest.eventCategory
          includeResponseContent: rest.includeResponseContent
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v1/notification-history/email
      name: v1-notification-history-email
      description: REST surface for v1-notification-history-email.
      operations:
      - method: GET
        name: getemailhistory
        description: List email notification histories
        call: v1-notifications.getemailhistory
        with:
          accountId: rest.accountId
          endTime: rest.endTime
          startTime: rest.startTime
          objectId: rest.objectId
          failedOnly: rest.failedOnly
          eventCategory: rest.eventCategory
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: v1-notifications-mcp
    port: 9090
    transport: http
    description: MCP adapter for API Reference — Notifications. One tool per consumed operation, routed inline through this
      capability's consumes block.
    tools:
    - name: resend-callout-notifications
      description: Resend callout notifications
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: v1-notifications.postresendcalloutnotifications
      with:
        POSTResendCalloutNotifications: tools.POSTResendCalloutNotifications
      outputParameters:
      - type: object
        mapping: $.
    - name: resend-email-notifications
      description: Resend email notifications
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: v1-notifications.postresendemailnotifications
      with:
        POSTResendEmailNotifications: tools.POSTResendEmailNotifications
      outputParameters:
      - type: object
        mapping: $.
    - name: create-email-template
      description: Create an email template
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: v1-notifications.postcreateemailtemplate
      with:
        POSTPublicEmailTemplateRequest: tools.POSTPublicEmailTemplateRequest
      outputParameters:
      - type: object
        mapping: $.
    - name: list-email-templates
      description: List email templates
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: v1-notifications.getqueryemailtemplates
      with:
        start: tools.start
        limit: tools.limit
        eventCategory: tools.eventCategory
        eventTypeName: tools.eventTypeName
        name: tools.name
      outputParameters:
      - type: object
        mapping: $.
    - name: create-update-email-templates
      description: Create or update email templates
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: v1-notifications.postcreateorupdateemailtemplates
      with:
        POSTCreateOrUpdateEmailTemplateRequest: tools.POSTCreateOrUpdateEmailTemplateRequest
      outputParameters:
      - type: object
        mapping: $.
    - name: update-email-template
      description: Update an email template
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: v1-notifications.putupdateemailtemplate
      with:
        id: tools.id
        PUTPublicEmailTemplateRequest: tools.PUTPublicEmailTemplateRequest
      outputParameters:
      - type: object
        mapping: $.
    - name: retrieve-email-template
      description: Retrieve an email template
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: v1-notifications.getgetemailtemplate
      with:
        id: tools.id
      outputParameters:
      - type: object
        mapping: $.
    - name: delete-email-template
      description: Delete an email template
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: v1-notifications.deletedeleteemailtemplate
      with:
        id: tools.id
      outputParameters:
      - type: object
        mapping: $.
    - name: delete-notification-histories-account
      description: Delete notification histories for an account
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: v1-notifications.deletedeletenotificationhistoryforaccount
      with:
        accountId: tools.accountId
      outputParameters:
      - type: object
        mapping: $.
    - name: retrieve-notification-history-deletion-task
      description: Retrieve a notification history deletion task
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: v1-notifications.getgetnotificationhistorydeletiontask
      with:
        id: tools.id
      outputParameters:
      - type: object
        mapping: $.
    - name: create-notification-definition
      description: Create a notification definition
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: v1-notifications.postcreatenotificationdefinition
      with:
        entity: tools.entity
      outputParameters:
      - type: object
        mapping: $.
    - name: list-notification-definitions
      description: List notification definitions
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: v1-notifications.getquerynotificationdefinitions
      with:
        start: tools.start
        limit: tools.limit
        profileId: tools.profileId
        eventTypeName: tools.eventTypeName
        emailTemplateId: tools.emailTemplateId
      outputParameters:
      - type: object
        mapping: $.
    - name: update-notification-definition
      description: Update a notification definition
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: v1-notifications.putupdatenotificationdefinition
      with:
        id: tools.id
        PUTPublicNotificationDefinitionRequest: tools.PUTPublicNotificationDefinitionRequest
      outputParameters:
      - type: object
        mapping: $.
    - name: retrieve-notification-definition
      description: Retrieve a notification definition
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: v1-notifications.getgetnotificationdefinition
      with:
        id: tools.id
      outputParameters:
      - type: object
        mapping: $.
    - name: delete-notification-definition
      description: Delete a notification definition
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: v1-notifications.deletedeletenotificationdefinition
      with:
        id: tools.id
      outputParameters:
      - type: object
        mapping: $.
    - name: list-callout-notification-histories
      description: List callout notification histories
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: v1-notifications.getcallouthistory
      with:
        endTime: tools.endTime
        startTime: tools.startTime
        objectId: tools.objectId
        failedOnly: tools.failedOnly
        eventCategory: tools.eventCategory
        includeResponseContent: tools.includeResponseContent
      outputParameters:
      - type: object
        mapping: $.
    - name: list-email-notification-histories
      description: List email notification histories
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: v1-notifications.getemailhistory
      with:
        accountId: tools.accountId
        endTime: tools.endTime
        startTime: tools.startTime
        objectId: tools.objectId
        failedOnly: tools.failedOnly
        eventCategory: tools.eventCategory
      outputParameters:
      - type: object
        mapping: $.