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

# Listar registros do webhook

> Lista as entregas do webhook, das mais novas para as mais antigas, com o corpo enviado e a resposta do endpoint. O tamanho da página é definido pelo servidor: leia `meta.per_page`.



## OpenAPI

````yaml /openapi.json get /webhooks/{webhook}/logs
openapi: 3.1.0
info:
  title: PostClean API
  version: 2.0.0
  description: >-
    API REST do PostClean. Autentique com uma chave de API do workspace, enviada
    como token Bearer no cabeçalho `Authorization`.
servers:
  - url: https://post.chatclean.com.br/api
    description: PostClean
security:
  - bearerAuth: []
tags:
  - name: Posts
    description: Criar, ler, atualizar, excluir e pré-visualizar posts.
  - name: Post notes
    description: Notas internas de um post, visíveis aos membros do workspace.
  - name: Approvals
    description: Aprovar ou rejeitar posts que aguardam aprovação.
  - name: Recurrence
    description: Fazer um post se repetir numa frequência.
  - name: Media and uploads
    description: Enviar arquivos e anexar mídia aos posts.
  - name: Social accounts
    description: Contas sociais conectadas e as opções de cada rede.
  - name: Channels
    description: Horários de postagem e fila de um canal.
  - name: Ideas
    description: Ideias do quadro Criar.
  - name: Idea stages
    description: As colunas (etapas) do quadro de ideias.
  - name: Analytics
    description: Métricas do workspace e dos canais.
  - name: Labels
    description: Etiquetas para organizar posts e ideias.
  - name: Signatures
    description: Textos reutilizáveis para adicionar aos posts.
  - name: Workspace
    description: O workspace ao qual a chave de API pertence.
  - name: API keys
    description: Chaves de API pessoais deste workspace.
  - name: Webhooks
    description: Webhooks de saída e os registros de entrega.
  - name: Repurposes
    description: Automações que republicam vídeos postados fora do PostClean.
  - name: Platform
    description: Recursos de cada plataforma e tipos de conteúdo.
paths:
  /webhooks/{webhook}/logs:
    parameters:
      - $ref: '#/components/parameters/WebhookId'
    get:
      tags:
        - Webhooks
      summary: Listar registros do webhook
      description: >-
        Lista as entregas do webhook, das mais novas para as mais antigas, com o
        corpo enviado e a resposta do endpoint. O tamanho da página é definido
        pelo servidor: leia `meta.per_page`.
      operationId: listWebhookLogs
      parameters:
        - name: page
          in: query
          required: false
          schema:
            type: integer
            minimum: 1
            default: 1
      responses:
        '200':
          description: Uma página de entregas.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/WebhookLog'
                  links:
                    $ref: '#/components/schemas/PaginationLinks'
                  meta:
                    $ref: '#/components/schemas/PaginationMeta'
              example:
                data:
                  - id: 9b2c3d50-6a7b-4c8d-9e0f-1a2b3c4d5e6f
                    event_type: post.published
                    payload:
                      id: 9b2c3d50-6a7b-4c8d-9e0f-1a2b3c4d5e6f
                      type: post.published
                      data:
                        id: 9d3c1f2a-6b4e-4c8a-9f1e-2a7b5c8d0e41
                        workspace_id: 9a0b1c2d-3e4f-4a5b-8c6d-7e8f9a0b1c2d
                        user_id: 9b1e2d3c-4f5a-4b6c-8d7e-9f0a1b2c3d4e
                        status: published
                        created_via: api
                        content: >-
                          Acabamos de lançar as threads agendadas. Veja como
                          funcionam.
                        scheduled_at: '2026-10-08T14:00:00+00:00'
                        published_at: '2026-10-08T14:00:02+00:00'
                        created_at: '2026-10-08T13:20:11+00:00'
                        updated_at: '2026-10-08T14:00:02+00:00'
                        author:
                          id: 9b1e2d3c-4f5a-4b6c-8d7e-9f0a1b2c3d4e
                          name: Ana Souza
                        workspace:
                          id: 9a0b1c2d-3e4f-4a5b-8c6d-7e8f9a0b1c2d
                          name: PostClean
                        labels:
                          - id: 9c0d1e2f-3a4b-4c5d-8e6f-7a8b9c0d1e2f
                            name: Lançamento
                            color: '#2563EB'
                        media: []
                        platforms:
                          - id: 9d3c1f2b-7c5f-4d9b-8a2f-3b8c6d9e1f52
                            social_account_id: 9c8b7a65-4d3e-4f2a-8b1c-0d9e8f7a6b54
                            platform: x
                            content_type: x_post
                            enabled: true
                            status: published
                            platform_post_id: '1843456789012345678'
                            platform_url: https://x.com/postclean/status/1843456789012345678
                            published_at: '2026-10-08T14:00:02+00:00'
                            error_message: null
                            error_context: null
                            display_name: PostClean
                            display_username: postclean
                            display_avatar: >-
                              https://pbs.twimg.com/profile_images/1790000000000000000/avatar_400x400.jpg
                            meta: []
                            social_account:
                              id: 9c8b7a65-4d3e-4f2a-8b1c-0d9e8f7a6b54
                              platform: x
                              display_name: PostClean
                              username: postclean
                              status: connected
                      created_at: '2026-10-08T14:00:02+00:00'
                    response_status: 200
                    response_body: ok
                    delivered_at: '2026-10-08T14:00:03+00:00'
                    failed_at: null
                    attempts: 1
                    created_at: '2026-10-08T14:00:02+00:00'
                links:
                  first: >-
                    https://post.chatclean.com.br/api/webhooks/9b2c3d4e-5f6a-4b7c-8d9e-0f1a2b3c4d5e/logs?page=1
                  last: >-
                    https://post.chatclean.com.br/api/webhooks/9b2c3d4e-5f6a-4b7c-8d9e-0f1a2b3c4d5e/logs?page=1
                  prev: null
                  next: null
                meta:
                  current_page: 1
                  from: 1
                  last_page: 1
                  links:
                    - url: null
                      label: '« Previous'
                      page: null
                      active: false
                    - url: >-
                        https://post.chatclean.com.br/api/webhooks/9b2c3d4e-5f6a-4b7c-8d9e-0f1a2b3c4d5e/logs?page=1
                      label: '1'
                      page: 1
                      active: true
                    - url: null
                      label: Next »
                      page: null
                      active: false
                  path: >-
                    https://post.chatclean.com.br/api/webhooks/9b2c3d4e-5f6a-4b7c-8d9e-0f1a2b3c4d5e/logs
                  per_page: 25
                  to: 1
                  total: 1
        '401':
          $ref: '#/components/responses/Unauthorized'
        '402':
          $ref: '#/components/responses/PaymentRequired'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/TooManyRequests'
components:
  parameters:
    WebhookId:
      name: webhook
      in: path
      required: true
      description: Id do webhook. Um webhook de outro workspace devolve `404`.
      schema:
        type: string
        format: uuid
      example: 9b2c3d4e-5f6a-4b7c-8d9e-0f1a2b3c4d5e
  schemas:
    WebhookLog:
      type: object
      properties:
        id:
          type: string
          format: uuid
          description: Id da entrega. É também o `id` do corpo entregue.
        event_type:
          $ref: '#/components/schemas/WebhookEventType'
        payload:
          type: object
          description: >-
            O corpo enviado: `{id, type, data, created_at}`. `data` é o post
            (`id, workspace_id, user_id, status, created_via, content,
            scheduled_at, published_at, created_at, updated_at, author,
            workspace, labels, media, platforms`), ou `{id, workspace_id}` em
            `post.deleted`.
        response_status:
          type:
            - integer
            - 'null'
        response_body:
          type:
            - string
            - 'null'
          description: >-
            Os primeiros 2000 bytes da resposta do endpoint, ou o erro de
            conexão.
        delivered_at:
          type:
            - string
            - 'null'
          format: date-time
          description: ISO 8601, em UTC.
        failed_at:
          type:
            - string
            - 'null'
          format: date-time
          description: ISO 8601, em UTC.
        attempts:
          type: integer
          description: Tentativas feitas para esta entrega (até 3).
        created_at:
          type: string
          format: date-time
          description: ISO 8601, em UTC.
          examples:
            - '2026-10-08T14:00:02+00:00'
    PaginationLinks:
      type: object
      properties:
        first:
          type:
            - string
            - 'null'
        last:
          type:
            - string
            - 'null'
        prev:
          type:
            - string
            - 'null'
        next:
          type:
            - string
            - 'null'
      description: Links para a primeira, a última, a anterior e a próxima página.
    PaginationMeta:
      type: object
      properties:
        current_page:
          type: integer
          description: Página atual.
        from:
          type:
            - integer
            - 'null'
        last_page:
          type: integer
          description: Última página.
        links:
          type: array
          items:
            type: object
            properties:
              url:
                type:
                  - string
                  - 'null'
              label:
                type: string
              page:
                type:
                  - integer
                  - 'null'
              active:
                type: boolean
          description: Links de navegação entre páginas.
        path:
          type: string
        per_page:
          type: integer
          description: >-
            Tamanho da página definido pelo servidor (hoje 25). Leia o valor em
            vez de supor.
        to:
          type:
            - integer
            - 'null'
        total:
          type: integer
          description: Total de itens em todas as páginas.
      description: Dados da página atual de uma lista paginada.
    WebhookEventType:
      type: string
      enum:
        - post.created
        - post.scheduled
        - post.unscheduled
        - post.published
        - post.partially_published
        - post.failed
        - post.deleted
      description: >-
        - `post.created`: um post foi criado. O `data.status` é o status com que
        ele foi criado (`draft`, `scheduled`, `publishing` ou
        `pending_approval`).

        - `post.scheduled`: um post existente foi agendado (por exemplo, um
        rascunho agendado ou uma solicitação aprovada). Um post criado já
        agendado envia só `post.created`.

        - `post.unscheduled`: um post agendado voltou para rascunho ou para
        aguardando aprovação.

        - `post.published`: o post foi publicado em todos os canais.

        - `post.partially_published`: o post foi publicado em alguns canais e
        falhou em outros.

        - `post.failed`: a publicação falhou.

        - `post.deleted`: um post foi excluído. Não é enviado para posts
        importados da rede nem para posts removidos ao desconectar o canal
        deles. O `data` é só `{id, workspace_id}`.
    ErrorBody:
      type: object
      properties:
        message:
          type: string
      description: Corpo de erro com uma mensagem.
    RateLimitErrorBody:
      type: object
      properties:
        name:
          type: string
          const: rate_limit_exceeded
        message:
          type: string
          examples:
            - Rate limit exceeded. Please retry after 30 seconds.
      description: Corpo devolvido quando o limite de requisições é excedido.
  responses:
    Unauthorized:
      description: >-
        Chave de API ausente, inválida, revogada ou expirada. Corpos possíveis:
        `Unauthenticated.` (sem chave, ou chave inválida ou revogada), `Token
        expired.` (passou do `expires_at`), `Token not found.` e `No workspace
        selected.` (a chave não está mais ligada a um workspace).
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorBody'
          example:
            message: Unauthenticated.
    PaymentRequired:
      description: >-
        A conta do workspace não tem assinatura ativa nem período de teste.
        Corpo: `{"message": "Active subscription required."}`.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorBody'
          example:
            message: Active subscription required.
    Forbidden:
      description: >-
        A requisição não é permitida. Chaves de API só funcionam para
        administradores do workspace (o dono da conta ou um membro marcado como
        administrador); fora isso, toda requisição devolve `Insufficient
        workspace permissions.`. Outros corpos: `Workspace access denied.` (o
        usuário da chave saiu do workspace), `Personal access token required.`
        (foi enviado um token OAuth do MCP) e `This action is unauthorized.`
        (por exemplo, a nota pertence a outro membro).
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorBody'
    NotFound:
      description: O recurso não existe neste workspace.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorBody'
    TooManyRequests:
      description: 'Limite de requisições excedido: 60 por minuto por workspace.'
      headers:
        Retry-After:
          description: Segundos de espera antes de tentar de novo.
          schema:
            type: integer
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/RateLimitErrorBody'
          example:
            name: rate_limit_exceeded
            message: Rate limit exceeded. Please retry after 30 seconds.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: Chave de API do workspace, criada em Configurações > Chaves de API.

````

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