> ## Documentation Index
> Fetch the complete documentation index at: https://widgetic.com/llms.txt
> Use this file to discover all available pages before exploring further.

# How your notifications reached you

> Lists the sends of your notifications, the newest first: each email to one address and each call to your
webhook, with whether it was delivered, when it is tried again if not, how many attempts it had, and why the
last one failed. Use it to find out why a webhook of yours did not receive an event.

An email counts as delivered when it was handed to the mail service; a call to your webhook counts as
delivered when your endpoint answered with a 2xx status. Anything else is tried again, after 1 minute, then
5 minutes, 30 minutes, 2 hours, 6 hours, 12 hours and a day, eight attempts in all, because your address is
read again at each attempt and you may have mended it. Two answers end the delivery at once: `410 Gone` and
`413 Payload Too Large`.

The caller must be the person who administers the partner (an API key of that account works, with the
`partner:read` scope), or a Widgetic administrator.




## OpenAPI

````yaml /openapi/widgetic-api-public.json get /partners/{partnerId}/notifications/deliveries
openapi: 3.0.0
info:
  title: Widgetic API Gateway
  version: 1.0.0
  description: API documentation for the Widgetic API Gateway
  license:
    name: Widgetic Integration License
    url: https://docs.widgetic.com/resources/license
servers:
  - url: https://api.widgetic.com/v1
    description: Production server
    variables:
      env:
        default: production
        description: Environment
      apiUrl:
        default: https://api.widgetic.com
        description: API URL
      apiVersion:
        default: /v1
        description: API Version path prefix
security: []
tags: []
paths:
  /partners/{partnerId}/notifications/deliveries:
    get:
      tags:
        - Partners
      summary: How your notifications reached you
      description: >
        Lists the sends of your notifications, the newest first: each email to
        one address and each call to your

        webhook, with whether it was delivered, when it is tried again if not,
        how many attempts it had, and why the

        last one failed. Use it to find out why a webhook of yours did not
        receive an event.


        An email counts as delivered when it was handed to the mail service; a
        call to your webhook counts as

        delivered when your endpoint answered with a 2xx status. Anything else
        is tried again, after 1 minute, then

        5 minutes, 30 minutes, 2 hours, 6 hours, 12 hours and a day, eight
        attempts in all, because your address is

        read again at each attempt and you may have mended it. Two answers end
        the delivery at once: `410 Gone` and

        `413 Payload Too Large`.


        The caller must be the person who administers the partner (an API key of
        that account works, with the

        `partner:read` scope), or a Widgetic administrator.
      operationId: listPartnerNotificationDeliveries
      parameters:
        - in: path
          name: partnerId
          required: true
          schema:
            type: string
            format: uuid
          description: The partner whose deliveries to list
        - in: query
          name: limit
          schema:
            type: integer
            minimum: 1
            maximum: 200
            default: 100
          description: How many deliveries to list at most
      responses:
        '200':
          description: The deliveries, the newest first
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PartnerNotificationDeliveryLogResponse'
        '400':
          description: '`limit` is not valid'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: The API key is missing or invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: The caller does not administer this partner
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '429':
          description: Too many requests. Wait a minute.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
        - apiKeyAuth: []
components:
  schemas:
    PartnerNotificationDeliveryLogResponse:
      type: object
      required:
        - success
        - data
      properties:
        success:
          type: boolean
          description: Always `true` on a success.
          example: true
        data:
          $ref: '#/components/schemas/PartnerNotificationDeliveryLog'
        meta:
          $ref: '#/components/schemas/ResponseMeta'
    ErrorResponse:
      type: object
      required:
        - success
        - message
        - error
      additionalProperties: true
      properties:
        success:
          type: boolean
          description: Always `false` on a failure.
          example: false
        message:
          type: string
          description: The same text as `error.message`, for a caller that reads one line.
        error:
          $ref: '#/components/schemas/ErrorDetail'
    PartnerNotificationDeliveryLog:
      type: object
      description: How the notifications reached their addresses, the newest first.
      required:
        - deliveries
      properties:
        deliveries:
          type: array
          items:
            $ref: '#/components/schemas/PartnerNotificationDelivery'
      example:
        deliveries:
          - Example PartnerNotificationDelivery
    ResponseMeta:
      type: object
      description: >-
        Extra information about the answer: where a page sits in a list, the
        cursor of the next page, or warnings about a call that succeeded with a
        caveat.
      additionalProperties: true
      properties:
        page:
          type: integer
          description: The page that was read, counting from 1.
          example: 1
        size:
          type: integer
          description: How many items one page holds.
          example: 20
        total:
          type: integer
          description: How many items the whole list has.
          example: 135
        limit:
          type: integer
          description: The same as `size`.
          example: 20
        offset:
          type: integer
          description: How many items come before this page.
          example: 0
        hasNextPage:
          type: boolean
          example: true
        hasPreviousPage:
          type: boolean
          example: false
        nextCursor:
          type: string
          nullable: true
          description: >-
            Pass this as `cursor` to read the next page of a list that is read
            by cursor. `null` on the last page.
        warnings:
          type: array
          items:
            type: string
          description: >-
            Things the call did not do, though it succeeded (for example a table
            that could not be created just now).
    ErrorDetail:
      type: object
      required:
        - code
        - message
        - timestamp
      properties:
        code:
          type: string
          description: Machine-readable error code.
          example: RESOURCE_NOT_FOUND
        message:
          type: string
          description: Human-readable explanation.
          example: Composition not found
        param:
          type: string
          description: The field that caused the error, when one did.
          example: name
        docUrl:
          type: string
          description: Where this error is explained.
        suggestedAction:
          type: string
          description: What to do about it.
        retryAfter:
          type: integer
          description: >-
            Seconds to wait before trying again (rate limits). The same number
            is in the `Retry-After` header.
          example: 60
        details:
          type: object
          additionalProperties: true
          description: >-
            More about the error: the fields that failed, a limit that was
            reached.
        correlationId:
          type: string
          description: Quote this when you ask support about the call.
          example: req_123e4567-e89b-12d3-a456-426614174000
        timestamp:
          type: string
          format: date-time
          example: '2026-10-15T10:00:00.000Z'
    PartnerNotificationDelivery:
      type: object
      description: >-
        One send of one notification, to one email address or to your webhook.
        It stays `pending` while it is being tried again, and ends `delivered`,
        `failed` (given up on) or `cancelled` (nobody wanted it any more, for
        example because the webhook was switched off).
      required:
        - deliveryId
        - notificationId
        - eventType
        - title
        - channel
        - target
        - status
        - attemptCount
        - nextAttemptAt
        - lastAttemptAt
        - deliveredAt
        - lastStatusCode
        - lastError
        - createdAt
        - replayOfDeliveryId
      properties:
        deliveryId:
          type: string
          format: uuid
        notificationId:
          type: string
          format: uuid
        eventType:
          type: string
          nullable: true
          description: >-
            What the notification was about. Null when the notification has been
            removed.
        title:
          type: string
          nullable: true
        channel:
          type: string
          enum:
            - email
            - webhook
        target:
          type: string
          description: >-
            The email address, or the host of your webhook (never the whole
            address, which may hold a token)
        status:
          type: string
          enum:
            - pending
            - delivered
            - failed
            - cancelled
        attemptCount:
          type: integer
        nextAttemptAt:
          type: string
          format: date-time
          nullable: true
          description: When the next attempt is made. Null once the delivery has ended.
        lastAttemptAt:
          type: string
          format: date-time
          nullable: true
        deliveredAt:
          type: string
          format: date-time
          nullable: true
        lastStatusCode:
          type: integer
          nullable: true
          description: >-
            The HTTP status your webhook answered with at the last attempt, when
            it answered
        lastError:
          type: string
          nullable: true
          description: >-
            Why the last attempt failed, in a few words. Never what your
            endpoint replied.
        createdAt:
          type: string
          format: date-time
        replayOfDeliveryId:
          type: string
          format: uuid
          nullable: true
          description: When this row is a manual replay, the earlier delivery it sent again
      example:
        deliveryId: 3fa85f64-5717-4562-b3fc-2c963f66afa6
        notificationId: 3fa85f64-5717-4562-b3fc-2c963f66afa6
        eventType: Example eventType
        title: Example title
        channel: Example channel
        target: Example target
        status: Example status
        attemptCount: 42
        nextAttemptAt: '2026-01-15T09:30:00.000Z'
        lastAttemptAt: '2026-01-15T09:30:00.000Z'
        deliveredAt: '2026-01-15T09:30:00.000Z'
        lastStatusCode: 42
        lastError: Example lastError
        createdAt: '2026-01-15T09:30:00.000Z'
        replayOfDeliveryId: 3fa85f64-5717-4562-b3fc-2c963f66afa6
  securitySchemes:
    apiKeyAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.